Example configuration file: session.xml
Session hardware object.
Contains information regarding the current session and methods to access and manipulate this information.
Bases: HardwareRepository.BaseHardwareObjects.HardwareObject
Returns the base data directory taking the ‘contextual’ information into account, such as if the current user is inhouse.
Returns: | The base data path. |
---|---|
Return type: | str |
Returns: | The base path for images. |
---|---|
Return type: | str |
Returns: | The base path for procesed data. |
---|---|
Return type: | str |
Returns the default prefix, using sample data such as the acronym as parts in the prefix.
Parameters: | sample_data_node (Sample) – The data node to get additional information from, (which will be added to the prefix). |
---|---|
Returns: | The default prefix. |
Return type: | str |
Returns the full path to images, using the name of each of data_nodes parents as sub directories.
Parameters: | data_node (TaskNode) – The data node to get additional information from, (which will be added to the path). |
---|---|
Returns: | The full path to images. |
Return type: | str |
Returns: | The current inhouse user. |
---|---|
Return type: | tuple (<proposal_code>, <proposal_number>) |
Returns the full path to processed data, using the name of each of data_nodes parents as sub directories.
Parameters: | data_node (TaskNode) – The data node to get additional information from, (which will be added to the path). |
---|---|
Returns: | The full path to images. |
Returns: | The proposal, ‘local-user’ if no proposal is available |
---|---|
Return type: | str |
Determines if a given proposal is considered to be inhouse.
Parameters: |
|
---|---|
Returns: | True if the proposal is inhouse, otherwise False. |
Return type: | bool |