Inscoper::NBO::TheAdditionalDimension¶

Represents the XML element TheAdditionalDimension. More...

#include <TheAdditionalDimension.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	TheAdditionalDimension()
	~TheAdditionalDimension()
std::string	getTypeName() const override Returns the class type name.
std::string	getXMLName() const override Returns the XML element name corresponding to this class.
ENBOType	getNBOType() const override Returns the NBO Type corresponding to this class.
std::vector< NBOBaseClassPtr >	getChildren() const override Returns a list of all classes derived from this class.
std::vector< NBOBaseClassPtr >	getSubElements() const override Returns a list of all child elements contained in this class.
void	fromJsonFile(const std::string & path, bool validate =true) Populates this object from a JSON file.
void	fromJsonString(const std::string & json_string, bool validate =true) Populates this object from a JSON string.
void	fromXmlFile(const std::string & path, bool validate =true) Populates this object from a XML file.
void	fromXmlString(const std::string & xml_string, bool validate =true) Populates this object from a XML string.
void	toXmlFile(const std::string & filename, bool validate =true) const Serializes this object to an XML file.
std::string	toXmlString(bool validate =true) const Serializes this object to an XML string.
void	setID(const Inscoper::NBO::LSID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LSID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setTheAdditionalDimensionIndex(const Inscoper::NBO::PositiveInt_TypePtr & value, bool validate =true) Sets the value of the TheAdditionalDimensionIndex attribute.
PositiveInt_TypePtr	getTheAdditionalDimensionIndex() const Returns the value of the TheAdditionalDimensionIndex attribute.
void	resetTheAdditionalDimensionIndex() Resets the TheAdditionalDimensionIndex attribute to an unset state.
bool	hasTheAdditionalDimensionIndex() const Checks whether the optional TheAdditionalDimensionIndex attribute is present.
void	setTheIncrementStamp(const float & value, bool validate =true) Sets the value of the TheIncrementStamp attribute.
float	getTheIncrementStamp() const Returns the value of the TheIncrementStamp attribute.
void	resetTheIncrementStamp() Resets the TheIncrementStamp attribute to an unset state.
bool	hasTheIncrementStamp() const Checks whether the TheIncrementStamp attribute is present.
std::shared_ptr< TheAdditionalDimension >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a TheAdditionalDimension.

Detailed Description¶

class Inscoper::NBO::TheAdditionalDimension;

Represents the XML element TheAdditionalDimension.

This element refers to each individual Plane of data pertaining to a given Additional Dimension.

Public Functions Documentation¶

function TheAdditionalDimension¶

function ~TheAdditionalDimension¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

void fromJsonFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

void fromJsonString(
    const std::string & json_string,
    bool validate =true
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

void fromXmlFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

void fromXmlString(
    const std::string & xml_string,
    bool validate =true
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

void toXmlFile(
    const std::string & filename,
    bool validate =true
) const

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlString¶

std::string toXmlString(
    bool validate =true
) const

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function setID¶

void setID(
    const Inscoper::NBO::LSID_TypePtr & value,
    bool validate =true
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A Unique Identifier for this component.

function getID¶

function resetID¶

function hasID¶

function setTheAdditionalDimensionIndex¶

void setTheAdditionalDimensionIndex(
    const Inscoper::NBO::PositiveInt_TypePtr & value,
    bool validate =true
)

Sets the value of the TheAdditionalDimensionIndex attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records the Index of this specific Plane within a vector of Additional Dimension data.

function getTheAdditionalDimensionIndex¶

PositiveInt_TypePtr getTheAdditionalDimensionIndex() const

Returns the value of the TheAdditionalDimensionIndex attribute.

Return: The value of the attribute

This field records the Index of this specific Plane within a vector of Additional Dimension data.

function resetTheAdditionalDimensionIndex¶

void 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.

function hasTheAdditionalDimensionIndex¶

bool hasTheAdditionalDimensionIndex() const

Checks whether the optional TheAdditionalDimensionIndex attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the Index of this specific Plane within a vector of Additional Dimension data.

function setTheIncrementStamp¶

void setTheIncrementStamp(
    const float & value,
    bool validate =true
)

Sets the value of the TheIncrementStamp attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

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.

function getTheIncrementStamp¶

float getTheIncrementStamp() const

Returns the value of the TheIncrementStamp attribute.

Return: The value of the 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.

function resetTheIncrementStamp¶

void 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.

function hasTheIncrementStamp¶

bool hasTheIncrementStamp() const

Checks whether the TheIncrementStamp attribute is present.

Return: true if the attribute has been set, false otherwise

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.

function fromBase¶

static std::shared_ptr< TheAdditionalDimension > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a TheAdditionalDimension.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Updated on 2026-09-23 at 16:50:39 +0200