Map_Type_InlineM

Bases: NBOBaseClass

Represents the XML element M.

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.

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

setK(value, validate=True)

Sets the value of the K attribute.

This is the key of this Key/Value pair.

Parameters:

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

getK()

Returns the value of the K attribute.

This is the key of this Key/Value pair.

Returns:

Type	Description
string	The value of the attribute

resetK()

Resets the K attribute to an unset state.

This is the key of this Key/Value pair.

hasK()

Checks whether the K attribute is present.

This is the key of this Key/Value pair.

Returns:

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

getKAllowedValues() staticmethod

Returns the allowed values for this attribut.

This is the key of this Key/Value pair.

Returns:

Type	Description
std::set< str,std::less< str >,std::allocator< str > >	The list of allowed values

set(v, validate=True)

Assigns a new value to this object.

Parameters:

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

get()

Returns the value of this object.

Returns:

Type	Description
string	The value of the object