BinaryFile_Choice

Bases: NBOBaseClass

Represents the XML choice in element BinaryFile.

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

setExternal(value, validate=True)

Sets the value of this object as a External element.

Parameters:

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

isExternal()

Checks whether this object is a External element.

Returns:

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

asExternal()

Returns the value of this object as a External element.

Returns:

Type	Description
External	The value as a External element

setBinData(value, validate=True)

Sets the value of this object as a BinData element.

Parameters:

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

isBinData()

Checks whether this object is a BinData element.

Returns:

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

asBinData()

Returns the value of this object as a BinData element.

Returns:

Type	Description
BinData	The value as a BinData element