ManufacturerSpec_Type

Bases: NBOBaseClass

Represents the XML complex type ManufacturerSpec.

This describes the Manufacturer specifications for this component (i.e., Manufacturer Name, Model designation and Catalog Number).

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

setManufacturer(value, validate=True)

Sets the value of the Manufacturer attribute.

This field refers to the company, research group or individual who built or manufactured this hardware component.

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

getManufacturer()

Returns the value of the Manufacturer attribute.

This field refers to the company, research group or individual who built or manufactured this hardware component.

Returns:

Type	Description
string	The value of the attribute

resetManufacturer()

Resets the Manufacturer attribute to an unset state.

This field refers to the company, research group or individual who built or manufactured this hardware component.

hasManufacturer()

Checks whether the Manufacturer attribute is present.

This field refers to the company, research group or individual who built or manufactured this hardware component.

Returns:

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

getManufacturerAllowedValues() staticmethod

Returns the allowed values for this attribut.

This field refers to the company, research group or individual who built or manufactured this hardware component.

Returns:

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

setModel(value, validate=True)

Sets the value of the Model attribute.

This field refers to the Model name or any other designation the Manufacturer uses for this component.

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

getModel()

Returns the value of the Model attribute.

This field refers to the Model name or any other designation the Manufacturer uses for this component.

Returns:

Type	Description
string	The value of the attribute

resetModel()

Resets the Model attribute to an unset state.

This field refers to the Model name or any other designation the Manufacturer uses for this component.

hasModel()

Checks whether the Model attribute is present.

This field refers to the Model name or any other designation the Manufacturer uses for this component.

Returns:

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

getModelAllowedValues() staticmethod

Returns the allowed values for this attribut.

This field refers to the Model name or any other designation the Manufacturer uses for this component.

Returns:

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

setCatalogNumber(value, validate=True)

Sets the value of the CatalogNumber attribute.

This field records the Catalog, Part or Serial Number used by the Manufacturer to uniquely identify this component.

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

getCatalogNumber()

Returns the value of the CatalogNumber attribute.

This field records the Catalog, Part or Serial Number used by the Manufacturer to uniquely identify this component.

Returns:

Type	Description
string	The value of the attribute

resetCatalogNumber()

Resets the CatalogNumber attribute to an unset state.

This field records the Catalog, Part or Serial Number used by the Manufacturer to uniquely identify this component.

hasCatalogNumber()

Checks whether the CatalogNumber attribute is present.

This field records the Catalog, Part or Serial Number used by the Manufacturer to uniquely identify this component.

Returns:

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

getCatalogNumberAllowedValues() staticmethod

Returns the allowed values for this attribut.

This field records the Catalog, Part or Serial Number used by the Manufacturer to uniquely identify this component.

Returns:

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

setLotNumber(value, validate=True)

Sets the value of the LotNumber attribute.

The Lot Number used by the Manufacturer to refer to a specific production batch or lot for this component.

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

getLotNumber()

Returns the value of the LotNumber attribute.

The Lot Number used by the Manufacturer to refer to a specific production batch or lot for this component.

Returns:

Type	Description
string	The value of the attribute

resetLotNumber()

Resets the LotNumber attribute to an unset state.

The Lot Number used by the Manufacturer to refer to a specific production batch or lot for this component.

hasLotNumber()

Checks whether the LotNumber attribute is present.

The Lot Number used by the Manufacturer to refer to a specific production batch or lot for this component.

Returns:

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

getLotNumberAllowedValues() staticmethod

Returns the allowed values for this attribut.

The Lot Number used by the Manufacturer to refer to a specific production batch or lot for this component.

Returns:

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

setMapAnnotation_List(value, validate=True)

Sets the list of MapAnnotation elements.

No description available in the XSD standard.

Parameters:

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

getMapAnnotation_List()

Returns the list of MapAnnotation elements.

No description available in the XSD standard.

Returns:

Type	Description
List[MapAnnotation]	The list of MapAnnotation elements

addToMapAnnotation_List(value, validate=True)

Adds a new MapAnnotation element to this object.

No description available in the XSD standard.

Parameters:

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

clearMapAnnotation_List()

Clear the list of MapAnnotation.

No description available in the XSD standard.

setSpecsFile(value, validate=True)

Sets the value of the SpecsFile element.

This element refers to a PDF file that contains the specifications for this hardware component as provided by the Manufacturer.

Parameters:

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

getSpecsFile()

Returns the value of the SpecsFile element.

This element refers to a PDF file that contains the specifications for this hardware component as provided by the Manufacturer.

Returns:

Type	Description
FileAnnotation_Type	The value of the element

resetSpecsFile()

Resets the SpecsFile element to an unset state.

This element refers to a PDF file that contains the specifications for this hardware component as provided by the Manufacturer.

hasSpecsFile()

Checks whether the optional SpecsFile element is present.

This element refers to a PDF file that contains the specifications for this hardware component as provided by the Manufacturer.

Returns:

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

setAdditionalVendorInformation_List(value, validate=True)

Sets the list of AdditionalVendorInformation elements.

No description available in the XSD standard.

Parameters:

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

getAdditionalVendorInformation_List()

Returns the list of AdditionalVendorInformation elements.

No description available in the XSD standard.

Returns:

Type	Description
List[AdditionalVendorInformation]	The list of AdditionalVendorInformation elements

addToAdditionalVendorInformation_List(value, validate=True)

Adds a new AdditionalVendorInformation element to this object.

No description available in the XSD standard.

Parameters:

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

clearAdditionalVendorInformation_List()

Clear the list of AdditionalVendorInformation.

No description available in the XSD standard.