Inscoper::NBO::BinaryFile¶

Represents the XML element BinaryFile. More...

#include <BinaryFile.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	BinaryFile()
	~BinaryFile()
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	setFileName(const std::string & value, bool validate =true) Sets the value of the FileName attribute.
std::string	getFileName() const Returns the value of the FileName attribute.
void	resetFileName() Resets the FileName attribute to an unset state.
bool	hasFileName() const Checks whether the FileName attribute is present.
void	setSize(const Inscoper::NBO::NonNegativeLong_TypePtr & value, bool validate =true) Sets the value of the Size attribute.
NonNegativeLong_TypePtr	getSize() const Returns the value of the Size attribute.
void	resetSize() Resets the Size attribute to an unset state.
bool	hasSize() const Checks whether the optional Size attribute is present.
void	setMIMEType(const std::string & value, bool validate =true) Sets the value of the MIMEType attribute.
std::string	getMIMEType() const Returns the value of the MIMEType attribute.
void	resetMIMEType() Resets the MIMEType attribute to an unset state.
bool	hasMIMEType() const Checks whether the MIMEType attribute is present.
void	setbinaryfile_choice(const Inscoper::NBO::BinaryFile_ChoicePtr & value, bool validate =true) Sets the value of the binaryfile_choice element.
Inscoper::NBO::BinaryFile_ChoicePtr	getbinaryfile_choice() const Returns the value of the binaryfile_choice element.
void	resetbinaryfile_choice() Resets the binaryfile_choice element to an unset state.
bool	hasbinaryfile_choice() const Checks whether the optional binaryfile_choice element is present.
std::shared_ptr< BinaryFile >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a BinaryFile.
const std::set< std::string > &	getFileNameAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getMIMETypeAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::BinaryFile;

Represents the XML element BinaryFile.

Size of the uncompressed file. [unit:bytes]

Public Functions Documentation¶

function BinaryFile¶

function ~BinaryFile¶

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

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

Sets the value of the FileName 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 getFileName¶

function resetFileName¶

function hasFileName¶

function setSize¶

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

Sets the value of the Size attribute.

Parameters:

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

Size of the uncompressed file. [unit:bytes]

function getSize¶

function resetSize¶

function hasSize¶

function setMIMEType¶

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

Sets the value of the MIMEType 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 getMIMEType¶

function resetMIMEType¶

function hasMIMEType¶

function setbinaryfile_choice¶

void setbinaryfile_choice(
    const Inscoper::NBO::BinaryFile_ChoicePtr & value,
    bool validate =true
)

Sets the value of the binaryfile_choice element.

Parameters:

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

No description available in the XSD standard.

function getbinaryfile_choice¶

Inscoper::NBO::BinaryFile_ChoicePtr getbinaryfile_choice() const

Returns the value of the binaryfile_choice element.

Return: The value of the element

No description available in the XSD standard.

function resetbinaryfile_choice¶

function hasbinaryfile_choice¶

bool hasbinaryfile_choice() const

Checks whether the optional binaryfile_choice element is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function fromBase¶

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

Cast a NBOBaseClass to a BinaryFile.

Parameters:

base The base class to cast

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

function getFileNameAllowedValues¶

function getMIMETypeAllowedValues¶

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

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