TheAdditionalDimension¶
Bases: NBOBaseClass
Represents the XML element TheAdditionalDimension.
This element refers to each individual Plane of data pertaining to a given Additional Dimension.
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 |
|---|---|
TheAdditionalDimension
|
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 component.
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 component.
Returns:
| Type | Description |
|---|---|
LSID_Type
|
The value of the attribute |
resetID()
¶
Resets the ID attribute to an unset state.
A Unique Identifier for this component.
hasID()
¶
Checks whether the optional ID attribute is present.
A Unique Identifier for this component.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setTheAdditionalDimensionIndex(value, validate=True)
¶
Sets the value of the TheAdditionalDimensionIndex attribute.
This field records the Index of this specific Plane within a vector of Additional Dimension data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
PositiveInt_Type
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getTheAdditionalDimensionIndex()
¶
Returns the value of the TheAdditionalDimensionIndex attribute.
This field records the Index of this specific Plane within a vector of Additional Dimension data.
Returns:
| Type | Description |
|---|---|
PositiveInt_Type
|
The value of the attribute |
resetTheAdditionalDimensionIndex()
¶
Resets the TheAdditionalDimensionIndex attribute to an unset state.
This field records the Index of this specific Plane within a vector of Additional Dimension data.
hasTheAdditionalDimensionIndex()
¶
Checks whether the optional TheAdditionalDimensionIndex attribute is present.
This field records the Index of this specific Plane within a vector of Additional Dimension data.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setTheIncrementStamp(value, validate=True)
¶
Sets the value of the TheIncrementStamp attribute.
This field records the actual Step Increment value associated with each Plane of data along this Additional Dimension vector for this Image. While, this field is only required with non-uniform sampling along this Additional Dimension (as indicated by a value of -1 stored in AdditionalDImension/ActualStepIncrement), it is always allowed.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getTheIncrementStamp()
¶
Returns the value of the TheIncrementStamp attribute.
This field records the actual Step Increment value associated with each Plane of data along this Additional Dimension vector for this Image. While, this field is only required with non-uniform sampling along this Additional Dimension (as indicated by a value of -1 stored in AdditionalDImension/ActualStepIncrement), it is always allowed.
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
resetTheIncrementStamp()
¶
Resets the TheIncrementStamp attribute to an unset state.
This field records the actual Step Increment value associated with each Plane of data along this Additional Dimension vector for this Image. While, this field is only required with non-uniform sampling along this Additional Dimension (as indicated by a value of -1 stored in AdditionalDImension/ActualStepIncrement), it is always allowed.
hasTheIncrementStamp()
¶
Checks whether the TheIncrementStamp attribute is present.
This field records the actual Step Increment value associated with each Plane of data along this Additional Dimension vector for this Image. While, this field is only required with non-uniform sampling along this Additional Dimension (as indicated by a value of -1 stored in AdditionalDImension/ActualStepIncrement), it is always allowed.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the attribute has been set, false otherwise |