OME_Choice_InlineOME_Choice_1

Bases: NBOBaseClass

Represents the XML element OME_Choice_1.

No description available in the XSD standard.

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
OME_Choice_InlineOME_Choice_1_InlineOME_Choice_1	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

setProject_List(value, validate=True)

Sets the list of Project elements.

No description available in the XSD standard.

Parameters:

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

getProject_List()

Returns the list of Project elements.

No description available in the XSD standard.

Returns:

Type	Description
List[Projec]	The list of Project elements

addToProject_List(value, validate=True)

Adds a new Project element to this object.

No description available in the XSD standard.

Parameters:

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

clearProject_List()

Clear the list of Project.

No description available in the XSD standard.

setDataset_List(value, validate=True)

Sets the list of Dataset elements.

No description available in the XSD standard.

Parameters:

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

getDataset_List()

Returns the list of Dataset elements.

No description available in the XSD standard.

Returns:

Type	Description
List[Datase]	The list of Dataset elements

addToDataset_List(value, validate=True)

Adds a new Dataset element to this object.

No description available in the XSD standard.

Parameters:

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

clearDataset_List()

Clear the list of Dataset.

No description available in the XSD standard.

setFolder_List(value, validate=True)

Sets the list of Folder elements.

No description available in the XSD standard.

Parameters:

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

getFolder_List()

Returns the list of Folder elements.

No description available in the XSD standard.

Returns:

Type	Description
List[Folde]	The list of Folder elements

addToFolder_List(value, validate=True)

Adds a new Folder element to this object.

No description available in the XSD standard.

Parameters:

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

clearFolder_List()

Clear the list of Folder.

No description available in the XSD standard.

setExperiment_List(value, validate=True)

Sets the list of Experiment elements.

No description available in the XSD standard.

Parameters:

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

getExperiment_List()

Returns the list of Experiment elements.

No description available in the XSD standard.

Returns:

Type	Description
List[Experimen]	The list of Experiment elements

addToExperiment_List(value, validate=True)

Adds a new Experiment element to this object.

No description available in the XSD standard.

Parameters:

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

clearExperiment_List()

Clear the list of Experiment.

No description available in the XSD standard.

setPlate_List(value, validate=True)

Sets the list of Plate elements.

No description available in the XSD standard.

Parameters:

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

getPlate_List()

Returns the list of Plate elements.

No description available in the XSD standard.

Returns:

Type	Description
List[Plate]	The list of Plate elements

addToPlate_List(value, validate=True)

Adds a new Plate element to this object.

No description available in the XSD standard.

Parameters:

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

clearPlate_List()

Clear the list of Plate.

No description available in the XSD standard.

setScreen_List(value, validate=True)

Sets the list of Screen elements.

No description available in the XSD standard.

Parameters:

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

getScreen_List()

Returns the list of Screen elements.

No description available in the XSD standard.

Returns:

Type	Description
List[Screen]	The list of Screen elements

addToScreen_List(value, validate=True)

Adds a new Screen element to this object.

No description available in the XSD standard.

Parameters:

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

clearScreen_List()

Clear the list of Screen.

No description available in the XSD standard.

setExperimenter_List(value, validate=True)

Sets the list of Experimenter elements.

No description available in the XSD standard.

Parameters:

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

getExperimenter_List()

Returns the list of Experimenter elements.

No description available in the XSD standard.

Returns:

Type	Description
List[Experimente]	The list of Experimenter elements

addToExperimenter_List(value, validate=True)

Adds a new Experimenter element to this object.

No description available in the XSD standard.

Parameters:

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

clearExperimenter_List()

Clear the list of Experimenter.

No description available in the XSD standard.

setExperimenterGroup_List(value, validate=True)

Sets the list of ExperimenterGroup elements.

No description available in the XSD standard.

Parameters:

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

getExperimenterGroup_List()

Returns the list of ExperimenterGroup elements.

No description available in the XSD standard.

Returns:

Type	Description
List[ExperimenterGroup]	The list of ExperimenterGroup elements

addToExperimenterGroup_List(value, validate=True)

Adds a new ExperimenterGroup element to this object.

No description available in the XSD standard.

Parameters:

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

clearExperimenterGroup_List()

Clear the list of ExperimenterGroup.

No description available in the XSD standard.

setInstrument_List(value, validate=True)

Sets the list of Instrument elements.

No description available in the XSD standard.

Parameters:

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

getInstrument_List()

Returns the list of Instrument elements.

No description available in the XSD standard.

Returns:

Type	Description
List[Instrumen]	The list of Instrument elements

addToInstrument_List(value, validate=True)

Adds a new Instrument element to this object.

No description available in the XSD standard.

Parameters:

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

clearInstrument_List()

Clear the list of Instrument.

No description available in the XSD standard.

setImage_List(value, validate=True)

Sets the list of Image elements.

No description available in the XSD standard.

Parameters:

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

getImage_List()

Returns the list of Image elements.

No description available in the XSD standard.

Returns:

Type	Description
List[Image]	The list of Image elements

addToImage_List(value, validate=True)

Adds a new Image element to this object.

No description available in the XSD standard.

Parameters:

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

clearImage_List()

Clear the list of Image.

No description available in the XSD standard.

setStructuredAnnotations(value, validate=True)

Sets the value of the StructuredAnnotations element.

No description available in the XSD standard.

Parameters:

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

getStructuredAnnotations()

Returns the value of the StructuredAnnotations element.

No description available in the XSD standard.

Returns:

Type	Description
StructuredAnnotations	The value of the element

resetStructuredAnnotations()

Resets the StructuredAnnotations element to an unset state.

No description available in the XSD standard.

hasStructuredAnnotations()

Checks whether the optional StructuredAnnotations element is present.

No description available in the XSD standard.

Returns:

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

setROI_List(value, validate=True)

Sets the list of ROI elements.

No description available in the XSD standard.

Parameters:

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

getROI_List()

Returns the list of ROI elements.

No description available in the XSD standard.

Returns:

Type	Description
List[ROI]	The list of ROI elements

addToROI_List(value, validate=True)

Adds a new ROI element to this object.

No description available in the XSD standard.

Parameters:

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

clearROI_List()

Clear the list of ROI.

No description available in the XSD standard.