search

mxcube / mxcubecore

Backend used by MXCuBE
http://mxcube.github.io/mxcube/
GNU Lesser General Public License v3.0
11 stars 51 forks source link

Added some more queue documentation #953

Open marcus-oscarsson opened 2 days ago

marcus-oscarsson commented 2 days ago

As promised Ive started to extend the queue documentation. I'm not very imaginative and a bit out of inspiration so I simply called the new queue entry "dynamic" queue entry with lack for a better term. Let me know if you have some nicer ideas :)

I'm working on the section on how to create/add these entries.

rhfogh commented 2 days ago

Good start. I look forward to the description of how you add an object to the queue - and how you query the queue, in either Qt or Web.

On the nesting of the queue, I do not think it is enough to say that 'there are no limits on the queue, but in practice it is always 'Sample-Group-DataCollection'. If I put a complex nested structure on the queue, will the databases, viewers, user interface etc. reflect it? Or will they compress the structure to have a single group containing all the leaf nodes? Or will some objects be ignored? Unless there is a known contract about how complex structures should be dealt with, it is hard to use them with any confidence.

marcus-oscarsson commented 2 days ago

Thanks @fabcor-maxiv

marcus-oscarsson commented 2 days ago

@rhfogh Ill add something about adding items and querying the queue within shortly :)

I'm not sure that I can answer the question about the nesting entirely as we have not defined any contract on the nesting/composition of the queue entries. I can possibly describe how its handled today but the scope would be somewhat limited to mxcubeweb (and possibly qt). I would probably not be the person to answer for the other part about databases and data-viewers. There is not necessarily a strong relation on the queue structure and how the data is represented in a database.