Skip to content

OME_Choice

Bases: NBOBaseClass

Represents the XML choice in element OME.

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)

Populates this object from a JSON file.

Parameters:

Name Type Description Default
path string

The path to the JSON file

required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name Type Description Default
json_string string

The JSON content as a string

required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name Type Description Default
path string

The path to the XML file

required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name Type Description Default
xml_string string

The XML content as a string

required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name Type Description Default
filename string

The path to the output XML file

required

toXmlString()

Serializes this object to an XML string.

Returns:

Type Description
string

A string containing the XML representation of this object

setOME_Choice_1(value)

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

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)

Sets the value of this object as a BinaryOnly element.

Parameters:

Name Type Description Default
value OME_Choice_InlineBinaryOnly

The value to set

required

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