AdditionalVendorInformation¶

Bases: NBOBaseClass

Represents the XML element AdditionalVendorInformation.

This element is intendended to be used as a last-resort solution to capture vendor-specific Additional Information about this hardware component, which cannot be described using either available model elements (Classes or Attributes) or the Map Annotation feature of the schema. The use of this feature should not be intended as a way to hide information that the Imaging Community has designated as essential to ensure rigor and reproducibility. In case this feature is used, the Vendor is fully responsible for this information, including but not limited to, making sure this information is appropriately recorded and kept up to date.

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

`setID(value, validate=True)` ¶

Sets the value of the ID attribute.

A Unique Identifier for this model element.

Parameters:

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

`getID()` ¶

Returns the value of the ID attribute.

A Unique Identifier for this model element.

Returns:

Type	Description
`LSID_Type`	The value of the attribute

`resetID()` ¶

Resets the ID attribute to an unset state.

A Unique Identifier for this model element.

`hasID()` ¶

Checks whether the optional ID attribute is present.

A Unique Identifier for this model element.

Returns:

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

`setVendorName(value, validate=True)` ¶

Sets the value of the VendorName attribute.

The Name of the Vendor responsible for this Information.

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`

`getVendorName()` ¶

Returns the value of the VendorName attribute.

The Name of the Vendor responsible for this Information.

Returns:

Type	Description
`string`	The value of the attribute

`resetVendorName()` ¶

Resets the VendorName attribute to an unset state.

The Name of the Vendor responsible for this Information.

`hasVendorName()` ¶

Checks whether the VendorName attribute is present.

The Name of the Vendor responsible for this Information.

Returns:

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

`getVendorNameAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

The Name of the Vendor responsible for this Information.

Returns:

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