Inscoper::NBO::CommentAnnotation¶

Represents the XML element CommentAnnotation. More...

#include <CommentAnnotation.h>

Inherits from Inscoper::NBO::TextAnnotation_Type, Inscoper::NBO::Annotation_Type, NBOBaseClass

Public Functions¶

	Name
	CommentAnnotation()
	~CommentAnnotation()
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	setValue(const std::string & value, bool validate =true) Sets the value of the Value element.
std::string	getValue() const Returns the value of the Value element.
std::shared_ptr< CommentAnnotation >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a CommentAnnotation.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::TextAnnotation_Type

	Name
	TextAnnotation_Type()
	~TextAnnotation_Type()

Public Classes inherited from Inscoper::NBO::Annotation_Type

	Name
class	InlineDescription Represents the XML element Description.

Public Types inherited from Inscoper::NBO::Annotation_Type

	Name
typedef std::shared_ptr< InlineDescription >	InlineDescriptionPtr

Public Functions inherited from Inscoper::NBO::Annotation_Type

	Name
	Annotation_Type()
	~Annotation_Type()
void	setID(const Inscoper::NBO::AnnotationID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
AnnotationID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setNamespace(const std::string & value, bool validate =true) Sets the value of the Namespace attribute.
std::string	getNamespace() const Returns the value of the Namespace attribute.
void	resetNamespace() Resets the Namespace attribute to an unset state.
bool	hasNamespace() const Checks whether the Namespace attribute is present.
void	setAnnotator(const Inscoper::NBO::ExperimenterID_TypePtr & value, bool validate =true) Sets the value of the Annotator attribute.
ExperimenterID_TypePtr	getAnnotator() const Returns the value of the Annotator attribute.
void	resetAnnotator() Resets the Annotator attribute to an unset state.
bool	hasAnnotator() const Checks whether the optional Annotator attribute is present.
void	setDescription(const Inscoper::NBO::Annotation_Type::InlineDescriptionPtr & value, bool validate =true) Sets the value of the Description element.
Inscoper::NBO::Annotation_Type::InlineDescriptionPtr	getDescription() const Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
bool	hasDescription() const Checks whether the optional Description element is present.
const std::set< std::string > &	getNamespaceAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::CommentAnnotation;

Represents the XML element CommentAnnotation.

An annotation that consists of a simple multi-line comment.

Public Functions Documentation¶

function CommentAnnotation¶

function ~CommentAnnotation¶

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

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

Sets the value of the Value element.

Parameters:

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

This element contains the actual content of this annotation. [multi-line string]

function getValue¶

function fromBase¶

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

Cast a NBOBaseClass to a CommentAnnotation.

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