Project

Bases: NBOBaseClass

Represents the XML element Project.

The Project ID is required. Datasets can be grouped into projects using a many-to-many relationship. A Dataset may belong to one or more Projects by including one or more ProjectRef elements which refer to Project IDs. Projects do not directly contain images - only by virtue of containing datasets, which themselves contain images.

fromBase(base) staticmethod

Cast a NBOBaseClass to a CMOS.

Parameters:

Name	Type	Description	Default
base	NBOBaseClass	The base class to cast	required

Returns:

Type	Description
Project	The casted element, or nullptr if the cast fails

getTypeName()

Returns the class type name.

Returns:

Type	Description
string	The class type name

getXMLName()

Returns the XML element name corresponding to this class.

Returns:

Type	Description
string	The XML element name

getNBOType()

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
int	The NBO Type value

getChildren()

Returns a list of all classes derived from this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of derived classes

getSubElements()

Returns a list of all child elements contained in this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of child classes

fromJsonFile(path, validate=True)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromJsonString(json_string, validate=True)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlFile(path, validate=True)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlString(xml_string, validate=True)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlFile(filename, validate=True)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlString(validate=True)

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

Returns:

Type	Description
string	A string containing the XML representation of this object

setName(value, validate=True)

Sets the value of the Name attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	string	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getName()

Returns the value of the Name attribute.

No description available in the XSD standard.

Returns:

Type	Description
string	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

No description available in the XSD standard.

hasName()

Checks whether the Name attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise

getNameAllowedValues() staticmethod

Returns the allowed values for this attribut.

No description available in the XSD standard.

Returns:

Type	Description
std::set< str,std::less< str >,std::allocator< str > >	The list of allowed values

setID(value, validate=True)

Sets the value of the ID attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ProjectID_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getID()

Returns the value of the ID attribute.

No description available in the XSD standard.

Returns:

Type	Description
ProjectID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

No description available in the XSD standard.

hasID()

Checks whether the optional ID attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setDescription(value, validate=True)

Sets the value of the Description element.

A description for the project. [plain-text multi-line string]

Parameters:

Name	Type	Description	Default
value	Project_InlineDescription	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getDescription()

Returns the value of the Description element.

A description for the project. [plain-text multi-line string]

Returns:

Type	Description
Project_InlineDescription	The value of the element

resetDescription()

Resets the Description element to an unset state.

A description for the project. [plain-text multi-line string]

hasDescription()

Checks whether the optional Description element is present.

A description for the project. [plain-text multi-line string]

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setExperimenterRef(value, validate=True)

Sets the value of the ExperimenterRef element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ExperimenterRef	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getExperimenterRef()

Returns the value of the ExperimenterRef element.

No description available in the XSD standard.

Returns:

Type	Description
ExperimenterRef	The value of the element

resetExperimenterRef()

Resets the ExperimenterRef element to an unset state.

No description available in the XSD standard.

hasExperimenterRef()

Checks whether the optional ExperimenterRef element is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setExperimenterGroupRef(value, validate=True)

Sets the value of the ExperimenterGroupRef element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	ExperimenterGroupRef	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getExperimenterGroupRef()

Returns the value of the ExperimenterGroupRef element.

No description available in the XSD standard.

Returns:

Type	Description
ExperimenterGroupRef	The value of the element

resetExperimenterGroupRef()

Resets the ExperimenterGroupRef element to an unset state.

No description available in the XSD standard.

hasExperimenterGroupRef()

Checks whether the optional ExperimenterGroupRef element is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setDatasetRef_List(value, validate=True)

Sets the list of DatasetRef elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[DatasetRef]	The new list of DatasetRef elements	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getDatasetRef_List()

Returns the list of DatasetRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[DatasetRef]	The list of DatasetRef elements

addToDatasetRef_List(value, validate=True)

Adds a new DatasetRef element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	DatasetRef	The element to add	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

clearDatasetRef_List()

Clear the list of DatasetRef.

No description available in the XSD standard.

setAnnotationRef_List(value, validate=True)

Sets the list of AnnotationRef elements.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	List[AnnotationRef]	The new list of AnnotationRef elements	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getAnnotationRef_List()

Returns the list of AnnotationRef elements.

No description available in the XSD standard.

Returns:

Type	Description
List[AnnotationRef]	The list of AnnotationRef elements

addToAnnotationRef_List(value, validate=True)

Adds a new AnnotationRef element to this object.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	AnnotationRef	The element to add	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

clearAnnotationRef_List()

Clear the list of AnnotationRef.

No description available in the XSD standard.