Inscoper::NBO::cellType_Type¶

Represents the XML complex type cellType. More...

#include <cellType_Type.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	cellType_Type()
	~cellType_Type()
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	setCellNr(const Inscoper::NBO::PositiveInt_TypePtr & value, bool validate =true) Sets the value of the CellNr attribute.
PositiveInt_TypePtr	getCellNr() const Returns the value of the CellNr attribute.
void	resetCellNr() Resets the CellNr attribute to an unset state.
bool	hasCellNr() const Checks whether the optional CellNr attribute is present.
void	setCellValue(const float & value, bool validate =true) Sets the value of the CellValue attribute.
float	getCellValue() const Returns the value of the CellValue attribute.
void	resetCellValue() Resets the CellValue attribute to an unset state.
bool	hasCellValue() const Checks whether the CellValue attribute is present.
void	setCellValueUnit(const std::string & value, bool validate =true) Sets the value of the CellValueUnit attribute.
std::string	getCellValueUnit() const Returns the value of the CellValueUnit attribute.
void	resetCellValueUnit() Resets the CellValueUnit attribute to an unset state.
bool	hasCellValueUnit() const Checks whether the CellValueUnit attribute is present.
std::shared_ptr< cellType_Type >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a cellType_Type.
const std::set< std::string > &	getCellValueUnitAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::cellType_Type;

Represents the XML complex type cellType.

The index of this Cell.

Public Functions Documentation¶

function cellType_Type¶

function ~cellType_Type¶

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

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

Sets the value of the CellNr attribute.

Parameters:

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

The index of this Cell.

function getCellNr¶

function resetCellNr¶

function hasCellNr¶

function setCellValue¶

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

Sets the value of the CellValue attribute.

Parameters:

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

The Value of the metric contained in this Cell.

function getCellValue¶

function resetCellValue¶

function hasCellValue¶

function setCellValueUnit¶

void setCellValueUnit(
    const std::string & value,
    bool validate =true
)

Sets the value of the CellValueUnit attribute.

Parameters:

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

No description available in the XSD standard.

function getCellValueUnit¶

function resetCellValueUnit¶

function hasCellValueUnit¶

function fromBase¶

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

Cast a NBOBaseClass to a cellType_Type.

Parameters:

base The base class to cast

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

function getCellValueUnitAllowedValues¶

static const std::set< std::string > & getCellValueUnitAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

No description available in the XSD standard.

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