Inscoper::NBO::Color_Type
Represents the XML simple type Color. More...
#include <Color_Type.h>
Inherits from NBOBaseClass
Public Functions
Name
Color_Type ()
~Color_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.
Color_Type &
operator= (const int & v) Assigns a new value to this object (= operator operator).
operator int () const Returns the value of this object (generic conversion operator overload).
void
set (const int & v, bool validate =true) Assigns a new value to this object.
int
get () const Returns the value of this object.
std::shared_ptr< Color_Type >
fromBase (NBOBaseClassPtr base) Cast a NBOBaseClass to a Color_Type .
Detailed Description
class Inscoper :: NBO :: Color_Type ;
Represents the XML simple type Color.
A simple type that identifies itself as a Color, the value is an integer between -2,147,483,648 and 2,147,483,647 (inclusive). The value is a signed 32 bit encoding of RGBA so "-1" is #FFFFFFFF or solid white. NOTE: Prior to the 2012-06 schema the default values were incorrect and produced a transparent red not solid white.
Public Functions Documentation
function Color_Type function ~Color_Type function getTypeName
std :: string getTypeName () const override
Returns the class type name.
Return : The class type name
function getXMLName
std :: string getXMLName () const override
Returns the XML element name corresponding to this class.
Return : The XML element name
function getNBOType
ENBOType getNBOType () const override
Returns the NBO Type corresponding to this class.
Return : The NBO Type value
function getChildren
std :: vector < NBOBaseClassPtr > getChildren () const override
Returns a list of all classes derived from this class.
Return : The list of derived classes
function getSubElements
std :: vector < NBOBaseClassPtr > getSubElements () const override
Returns a list of all child elements contained in this class.
Return : The list of child classes
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 operator=
Color_Type & operator = (
const int & v
)
Assigns a new value to this object (= operator operator).
Parameters :
function operator int
Returns the value of this object (generic conversion operator overload).
Return : The value of the object
function set
void set (
const int & 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
Returns the value of this object.
Return : The value of the object
function fromBase
static std :: shared_ptr < Color_Type > fromBase (
NBOBaseClassPtr base
)
Cast a NBOBaseClass to a Color_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:37 +0200