Inscoper::NBO::Settings_Type¶

Represents the XML complex type Settings. More...

#include <Settings_Type.h>

Inherits from Inscoper::NBO::Reference_Type, NBOBaseClass

Public Functions¶

	Name
	Settings_Type()
	~Settings_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	setMapAnnotation_List(const std::vector< Inscoper::NBO::MapAnnotationPtr > & value, bool validate =true) Sets the list of MapAnnotation elements.
std::vector< Inscoper::NBO::MapAnnotationPtr >	getMapAnnotation_List() const Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(const Inscoper::NBO::MapAnnotationPtr & value, bool validate =true) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setAdditionalVendorInformation_List(const std::vector< Inscoper::NBO::AdditionalVendorInformationPtr > & value, bool validate =true) Sets the list of AdditionalVendorInformation elements.
std::vector< Inscoper::NBO::AdditionalVendorInformationPtr >	getAdditionalVendorInformation_List() const Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(const Inscoper::NBO::AdditionalVendorInformationPtr & value, bool validate =true) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.
std::shared_ptr< Settings_Type >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Settings_Type.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::Reference_Type

	Name
	Reference_Type()
	~Reference_Type()

Detailed Description¶

class Inscoper::NBO::Settings_Type;

Represents the XML complex type Settings.

No description available in the XSD standard.

Public Functions Documentation¶

function Settings_Type¶

function ~Settings_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 setMapAnnotation_List¶

void setMapAnnotation_List(
    const std::vector< Inscoper::NBO::MapAnnotationPtr > & value,
    bool validate =true
)

Sets the list of MapAnnotation elements.

Parameters:

value The new list of MapAnnotation elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getMapAnnotation_List¶

std::vector< Inscoper::NBO::MapAnnotationPtr > getMapAnnotation_List() const

Returns the list of MapAnnotation elements.

Return: The list of MapAnnotation elements

No description available in the XSD standard.

function addToMapAnnotation_List¶

void addToMapAnnotation_List(
    const Inscoper::NBO::MapAnnotationPtr & value,
    bool validate =true
)

Adds a new MapAnnotation element to this object.

Parameters:

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

No description available in the XSD standard.

function clearMapAnnotation_List¶

function setAdditionalVendorInformation_List¶

void setAdditionalVendorInformation_List(
    const std::vector< Inscoper::NBO::AdditionalVendorInformationPtr > & value,
    bool validate =true
)

Sets the list of AdditionalVendorInformation elements.

Parameters:

value The new list of AdditionalVendorInformation elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getAdditionalVendorInformation_List¶

std::vector< Inscoper::NBO::AdditionalVendorInformationPtr > getAdditionalVendorInformation_List() const

Returns the list of AdditionalVendorInformation elements.

Return: The list of AdditionalVendorInformation elements

No description available in the XSD standard.

function addToAdditionalVendorInformation_List¶

void addToAdditionalVendorInformation_List(
    const Inscoper::NBO::AdditionalVendorInformationPtr & value,
    bool validate =true
)

Adds a new AdditionalVendorInformation element to this object.

Parameters:

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

No description available in the XSD standard.

function clearAdditionalVendorInformation_List¶

function fromBase¶

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

Cast a NBOBaseClass to a Settings_Type.

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