Inscoper::NBO::Description

Represents the XML element Description. More...

#include <Description.h>

Inherits from NBOBaseClass

Public Functions

	Name
	Description()
	~Description()
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.
std::shared_ptr< Description >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Description.

Detailed Description

class Inscoper::NBO::Description;

Represents the XML element Description.

This element holds a free text multi-line optional description for this component.

Public Functions Documentation

function Description

function ~Description

function getTypeName

function getXMLName

function getNBOType

function getChildren

function getSubElements

function fromJsonFile

function fromJsonString

function fromXmlFile

function fromXmlString

function toXmlFile

function toXmlString

function fromBase