Inscoper::NBO::Map_Type::InlineM¶

Represents the XML element M. More...

#include <Map_Type.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	InlineM()
	~InlineM()
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	setK(const std::string & value, bool validate =true) Sets the value of the K attribute.
std::string	getK() const Returns the value of the K attribute.
void	resetK() Resets the K attribute to an unset state.
bool	hasK() const Checks whether the K attribute is present.
InlineM &	operator=(const std::string & v) Assigns a new value to this object (= operator operator).
	operator std::string() const Returns the value of this object (generic conversion operator overload).
void	set(const std::string & v, bool validate =true) Assigns a new value to this object.
std::string	get() const Returns the value of this object.
std::shared_ptr< InlineM >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a InlineM.
const std::set< std::string > &	getKAllowedValues() Returns the allowed values for this attribut.

Friends¶

	Name
std::ostream &	operator<<(std::ostream & os, const InlineM & u)

Detailed Description¶

class Inscoper::NBO::Map_Type::InlineM;

Represents the XML element M.

This is a Key/Value pair used to build up a Mapping. The Element and Attribute Name are kept to single letters to minimize the length at the expense of readability as they are likely to occur many times.

Public Functions Documentation¶

function InlineM¶

function ~InlineM¶

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

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

Sets the value of the K attribute.

Parameters:

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

This is the key of this Key/Value pair.

function getK¶

function resetK¶

function hasK¶

function operator=¶

function operator std::string¶

function set¶

void set(
    const std::string & v,
    bool validate =true
)

Assigns a new value to this object.

Parameters:

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

function get¶

function fromBase¶

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

Cast a NBOBaseClass to a InlineM.

Parameters:

base The base class to cast

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

Inscoper::NBO::Map_Type::InlineM¶

Public Functions¶

Friends¶

Detailed Description¶

Public Functions Documentation¶

function InlineM¶

function ~InlineM¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

function fromJsonString¶

function fromXmlFile¶

function fromXmlString¶

function toXmlFile¶

function toXmlString¶

function setK¶

function getK¶

function resetK¶

function hasK¶

function operator=¶

function operator std::string¶

function set¶

function get¶

function fromBase¶

function getKAllowedValues¶

Friends¶

friend operator<<¶