Inscoper::NBO::StructuredAnnotations¶

Represents the XML element StructuredAnnotations. More...

#include <StructuredAnnotations.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	StructuredAnnotations()
	~StructuredAnnotations()
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	setstructuredannotations_choice(const Inscoper::NBO::StructuredAnnotations_ChoicePtr & value, bool validate =true) Sets the value of the structuredannotations_choice element.
Inscoper::NBO::StructuredAnnotations_ChoicePtr	getstructuredannotations_choice() const Returns the value of the structuredannotations_choice element.
void	resetstructuredannotations_choice() Resets the structuredannotations_choice element to an unset state.
bool	hasstructuredannotations_choice() const Checks whether the optional structuredannotations_choice element is present.
std::shared_ptr< StructuredAnnotations >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a StructuredAnnotations.

Detailed Description¶

class Inscoper::NBO::StructuredAnnotations;

Represents the XML element StructuredAnnotations.

No description available in the XSD standard.

Public Functions Documentation¶

function StructuredAnnotations¶

function ~StructuredAnnotations¶

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

void setstructuredannotations_choice(
    const Inscoper::NBO::StructuredAnnotations_ChoicePtr & value,
    bool validate =true
)

Sets the value of the structuredannotations_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 getstructuredannotations_choice¶

Inscoper::NBO::StructuredAnnotations_ChoicePtr getstructuredannotations_choice() const

Returns the value of the structuredannotations_choice element.

Return: The value of the element

No description available in the XSD standard.

function resetstructuredannotations_choice¶

function hasstructuredannotations_choice¶

bool hasstructuredannotations_choice() const

Checks whether the optional structuredannotations_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< StructuredAnnotations > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a StructuredAnnotations.

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:39 +0200