Pixels_Choice¶

Bases: NBOBaseClass

Represents the XML choice in element Pixels.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a Pixels_Choice.

Parameters:

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

Returns:

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

`addBinData(value)` ¶

Adds a new BinData element to this object.

Parameters:

Name	Type	Description	Default
`value`	`List[BinData]`	The element to add	required

`containsBinData()` ¶

Checks whether this object contains at least one BinData element.

Returns:

Type	Description
`boolean`	true if a BinData element is present, false otherwise

`addMetadataOnly(value)` ¶

Adds a new MetadataOnly element to this object.

Parameters:

Name	Type	Description	Default
`value`	`List[MetadataOnly]`	The element to add	required

`containsMetadataOnly()` ¶

Checks whether this object contains at least one MetadataOnly element.

Returns:

Type	Description
`boolean`	true if a MetadataOnly element is present, false otherwise

`addNGFFData(value)` ¶

Adds a new NGFFData element to this object.

Parameters:

Name	Type	Description	Default
`value`	`List[NGFFData]`	The element to add	required

`containsNGFFData()` ¶

Checks whether this object contains at least one NGFFData element.

Returns:

Type	Description
`boolean`	true if a NGFFData element is present, false otherwise

`addTiffData(value)` ¶

Adds a new TiffData element to this object.

Parameters:

Name	Type	Description	Default
`value`	`List[TiffData]`	The element to add	required

`containsTiffData()` ¶

Checks whether this object contains at least one TiffData element.

Returns:

Type	Description
`boolean`	true if a TiffData element is present, false otherwise

Pixels_Choice¶

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) ¶

addBinData(value) ¶

containsBinData() ¶

addMetadataOnly(value) ¶

containsMetadataOnly() ¶

addNGFFData(value) ¶

containsNGFFData() ¶

addTiffData(value) ¶

containsTiffData() ¶

`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)` ¶

`addBinData(value)` ¶

`containsBinData()` ¶

`addMetadataOnly(value)` ¶

`containsMetadataOnly()` ¶

`addNGFFData(value)` ¶

`containsNGFFData()` ¶

`addTiffData(value)` ¶

`containsTiffData()` ¶