Inscoper::NBO::Project¶

Represents the XML element Project. More...

#include <Project.h>

Inherits from NBOBaseClass

Public Classes¶

	Name
class	InlineDescription Represents the XML element Description.

Public Types¶

	Name
typedef std::shared_ptr< InlineDescription >	InlineDescriptionPtr

Public Functions¶

	Name
	Project()
	~Project()
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	setName(const std::string & value, bool validate =true) Sets the value of the Name attribute.
std::string	getName() const Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
bool	hasName() const Checks whether the Name attribute is present.
void	setID(const Inscoper::NBO::ProjectID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
ProjectID_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	setDescription(const Inscoper::NBO::Project::InlineDescriptionPtr & value, bool validate =true) Sets the value of the Description element.
Inscoper::NBO::Project::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.
void	setExperimenterRef(const Inscoper::NBO::ExperimenterRefPtr & value, bool validate =true) Sets the value of the ExperimenterRef element.
Inscoper::NBO::ExperimenterRefPtr	getExperimenterRef() const Returns the value of the ExperimenterRef element.
void	resetExperimenterRef() Resets the ExperimenterRef element to an unset state.
bool	hasExperimenterRef() const Checks whether the optional ExperimenterRef element is present.
void	setExperimenterGroupRef(const Inscoper::NBO::ExperimenterGroupRefPtr & value, bool validate =true) Sets the value of the ExperimenterGroupRef element.
Inscoper::NBO::ExperimenterGroupRefPtr	getExperimenterGroupRef() const Returns the value of the ExperimenterGroupRef element.
void	resetExperimenterGroupRef() Resets the ExperimenterGroupRef element to an unset state.
bool	hasExperimenterGroupRef() const Checks whether the optional ExperimenterGroupRef element is present.
void	setDatasetRef_List(const std::vector< Inscoper::NBO::DatasetRefPtr > & value, bool validate =true) Sets the list of DatasetRef elements.
std::vector< Inscoper::NBO::DatasetRefPtr >	getDatasetRef_List() const Returns the list of DatasetRef elements.
void	addToDatasetRef_List(const Inscoper::NBO::DatasetRefPtr & value, bool validate =true) Adds a new DatasetRef element to this object.
void	clearDatasetRef_List() Clear the list of DatasetRef.
void	setAnnotationRef_List(const std::vector< Inscoper::NBO::AnnotationRefPtr > & value, bool validate =true) Sets the list of AnnotationRef elements.
std::vector< Inscoper::NBO::AnnotationRefPtr >	getAnnotationRef_List() const Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(const Inscoper::NBO::AnnotationRefPtr & value, bool validate =true) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
std::shared_ptr< Project >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Project.
const std::set< std::string > &	getNameAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::Project;

Represents the XML element Project.

The Project ID is required. Datasets can be grouped into projects using a many-to-many relationship. A Dataset may belong to one or more Projects by including one or more ProjectRef elements which refer to Project IDs. Projects do not directly contain images - only by virtue of containing datasets, which themselves contain images.

Public Types Documentation¶

typedef InlineDescriptionPtr¶

Public Functions Documentation¶

function Project¶

function ~Project¶

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

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

Sets the value of the Name 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 getName¶

function resetName¶

function hasName¶

function setID¶

void setID(
    const Inscoper::NBO::ProjectID_TypePtr & value,
    bool validate =true
)

Sets the value of the ID 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 getID¶

function resetID¶

function hasID¶

function setDescription¶

void setDescription(
    const Inscoper::NBO::Project::InlineDescriptionPtr & value,
    bool validate =true
)

Sets the value of the Description element.

Parameters:

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

A description for the project. [plain-text multi-line string]

function getDescription¶

Inscoper::NBO::Project::InlineDescriptionPtr getDescription() const

Returns the value of the Description element.

Return: The value of the element

A description for the project. [plain-text multi-line string]

function resetDescription¶

function hasDescription¶

bool hasDescription() const

Checks whether the optional Description element is present.

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

A description for the project. [plain-text multi-line string]

function setExperimenterRef¶

void setExperimenterRef(
    const Inscoper::NBO::ExperimenterRefPtr & value,
    bool validate =true
)

Sets the value of the ExperimenterRef 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 getExperimenterRef¶

function resetExperimenterRef¶

function hasExperimenterRef¶

bool hasExperimenterRef() const

Checks whether the optional ExperimenterRef element is present.

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

No description available in the XSD standard.

function setExperimenterGroupRef¶

void setExperimenterGroupRef(
    const Inscoper::NBO::ExperimenterGroupRefPtr & value,
    bool validate =true
)

Sets the value of the ExperimenterGroupRef 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 getExperimenterGroupRef¶

Inscoper::NBO::ExperimenterGroupRefPtr getExperimenterGroupRef() const

Returns the value of the ExperimenterGroupRef element.

Return: The value of the element

No description available in the XSD standard.

function resetExperimenterGroupRef¶

function hasExperimenterGroupRef¶

bool hasExperimenterGroupRef() const

Checks whether the optional ExperimenterGroupRef element is present.

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

No description available in the XSD standard.

function setDatasetRef_List¶

void setDatasetRef_List(
    const std::vector< Inscoper::NBO::DatasetRefPtr > & value,
    bool validate =true
)

Sets the list of DatasetRef elements.

Parameters:

value The new list of DatasetRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getDatasetRef_List¶

std::vector< Inscoper::NBO::DatasetRefPtr > getDatasetRef_List() const

Returns the list of DatasetRef elements.

Return: The list of DatasetRef elements

No description available in the XSD standard.

function addToDatasetRef_List¶

void addToDatasetRef_List(
    const Inscoper::NBO::DatasetRefPtr & value,
    bool validate =true
)

Adds a new DatasetRef element to this object.

Parameters:

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

No description available in the XSD standard.

function clearDatasetRef_List¶

function setAnnotationRef_List¶

void setAnnotationRef_List(
    const std::vector< Inscoper::NBO::AnnotationRefPtr > & value,
    bool validate =true
)

Sets the list of AnnotationRef elements.

Parameters:

value The new list of AnnotationRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function getAnnotationRef_List¶

std::vector< Inscoper::NBO::AnnotationRefPtr > getAnnotationRef_List() const

Returns the list of AnnotationRef elements.

Return: The list of AnnotationRef elements

No description available in the XSD standard.

function addToAnnotationRef_List¶

void addToAnnotationRef_List(
    const Inscoper::NBO::AnnotationRefPtr & value,
    bool validate =true
)

Adds a new AnnotationRef element to this object.

Parameters:

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

No description available in the XSD standard.

function clearAnnotationRef_List¶

function fromBase¶

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

Cast a NBOBaseClass to a Project.

Parameters:

base The base class to cast

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

function getNameAllowedValues¶

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

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