Map_Type¶

Bases: NBOBaseClass

Represents the XML complex type Map.

This is a Mapping of Key/Value pairs.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a Map_Type.

Parameters:

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

Returns:

Type	Description
`Map_Type`	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

`setM_List(value, validate=True)` ¶

Sets the list of M elements.

This is a Key/Value pair used to build up a Mapping. The Element and Attribute Name are kept to single letters to minimize the length at the expense of readability as they are likely to occur many times.

Parameters:

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

`getM_List()` ¶

Returns the list of M elements.

This is a Key/Value pair used to build up a Mapping. The Element and Attribute Name are kept to single letters to minimize the length at the expense of readability as they are likely to occur many times.

Returns:

Type	Description
`List[Map_Type_InlineM]`	The list of M elements

`addToM_List(value, validate=True)` ¶

Adds a new M element to this object.

This is a Key/Value pair used to build up a Mapping. The Element and Attribute Name are kept to single letters to minimize the length at the expense of readability as they are likely to occur many times.

Parameters:

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

Map_Type¶

fromBase(base) staticmethod ¶

getTypeName() ¶

getXMLName() ¶

getNBOType() ¶

getChildren() ¶

getSubElements() ¶

fromJsonFile(path, validate=True) ¶

fromJsonString(json_string, validate=True) ¶

fromXmlFile(path, validate=True) ¶

fromXmlString(xml_string, validate=True) ¶

toXmlFile(filename, validate=True) ¶

toXmlString(validate=True) ¶

setM_List(value, validate=True) ¶

getM_List() ¶

addToM_List(value, validate=True) ¶

clearM_List() ¶

`fromBase(base)` `staticmethod` ¶

`getTypeName()` ¶

`getXMLName()` ¶

`getNBOType()` ¶

`getChildren()` ¶

`getSubElements()` ¶

`fromJsonFile(path, validate=True)` ¶

`fromJsonString(json_string, validate=True)` ¶

`fromXmlFile(path, validate=True)` ¶

`fromXmlString(xml_string, validate=True)` ¶

`toXmlFile(filename, validate=True)` ¶

`toXmlString(validate=True)` ¶

`setM_List(value, validate=True)` ¶

`getM_List()` ¶

`addToM_List(value, validate=True)` ¶

`clearM_List()` ¶