OME_Choice

Bases: NBOBaseClass

Represents the XML choice in element OME.

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

setOME_Choice_1(value, validate=True)

Sets the value of this object as a OME_Choice_1 element.

Parameters:

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

isOME_Choice_1()

Checks whether this object is a OME_Choice_1 element.

Returns:

Type	Description
boolean	true if this object is a OME_Choice_1 element, false otherwise

asOME_Choice_1()

Returns the value of this object as a OME_Choice_1 element.

Returns:

Type	Description
OME_Choice_InlineOME_Choice_1	The value as a OME_Choice_1 element

setBinaryOnly(value, validate=True)

Sets the value of this object as a BinaryOnly element.

Parameters:

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

isBinaryOnly()

Checks whether this object is a BinaryOnly element.

Returns:

Type	Description
boolean	true if this object is a BinaryOnly element, false otherwise

asBinaryOnly()

Returns the value of this object as a BinaryOnly element.

Returns:

Type	Description
OME_Choice_InlineBinaryOnly	The value as a BinaryOnly element