Inscoper::NBO::BinData¶

Represents the XML element BinData. More...

#include <BinData.h>

Inherits from Inscoper::NBO::base64Binary_Type, NBOBaseClass

Public Functions¶

	Name
	BinData()
	~BinData()
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	setCompression(const std::string & value, bool validate =true) Sets the value of the Compression attribute.
std::string	getCompression() const Returns the value of the Compression attribute.
void	resetCompression() Resets the Compression attribute to an unset state.
bool	hasCompression() const Checks whether the Compression attribute is present.
void	setBigEndian(const bool & value, bool validate =true) Sets the value of the BigEndian attribute.
bool	getBigEndian() const Returns the value of the BigEndian attribute.
void	resetBigEndian() Resets the BigEndian attribute to an unset state.
bool	hasBigEndian() const Checks whether the BigEndian attribute is present.
void	setLength(const Inscoper::NBO::NonNegativeLong_TypePtr & value, bool validate =true) Sets the value of the Length attribute.
NonNegativeLong_TypePtr	getLength() const Returns the value of the Length attribute.
void	resetLength() Resets the Length attribute to an unset state.
bool	hasLength() const Checks whether the optional Length attribute is present.
std::shared_ptr< BinData >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a BinData.
const std::set< std::string > &	getCompressionAllowedValues() Returns the allowed values for this attribut.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::base64Binary_Type

	Name
	base64Binary_Type()
	~base64Binary_Type()
base64Binary_Type &	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.
const std::set< std::string > &	getAllowedValues() Returns the allowed values for this object.
const std::string &	getPattern() Returns the pattern for this object.

Friends inherited from Inscoper::NBO::base64Binary_Type

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

Detailed Description¶

class Inscoper::NBO::BinData;

Represents the XML element BinData.

The contents of this element are base64-encoded. These are not CDATA sections, just a base64 stream.

Public Functions Documentation¶

function BinData¶

function ~BinData¶

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

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

Sets the value of the Compression 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 getCompression¶

function resetCompression¶

function hasCompression¶

function setBigEndian¶

void setBigEndian(
    const bool & value,
    bool validate =true
)

Sets the value of the BigEndian 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 getBigEndian¶

function resetBigEndian¶

function hasBigEndian¶

function setLength¶

void setLength(
    const Inscoper::NBO::NonNegativeLong_TypePtr & value,
    bool validate =true
)

Sets the value of the Length 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 getLength¶

function resetLength¶

function hasLength¶

function fromBase¶

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

Cast a NBOBaseClass to a BinData.

Parameters:

base The base class to cast

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

function getCompressionAllowedValues¶

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

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