Inscoper::NBO::OME_Choice::InlineOME_Choice_1¶

Represents the XML element OME_Choice_1. More...

#include <OME_Choice.h>

Inherits from NBOBaseClass

Public Functions¶

	Name
	InlineOME_Choice_1()
	~InlineOME_Choice_1()
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	setProject_List(const std::vector< Inscoper::NBO::ProjectPtr > & value, bool validate =true) Sets the list of Project elements.
std::vector< Inscoper::NBO::ProjectPtr >	getProject_List() const Returns the list of Project elements.
void	addToProject_List(const Inscoper::NBO::ProjectPtr & value, bool validate =true) Adds a new Project element to this object.
void	clearProject_List() Clear the list of Project.
void	setDataset_List(const std::vector< Inscoper::NBO::DatasetPtr > & value, bool validate =true) Sets the list of Dataset elements.
std::vector< Inscoper::NBO::DatasetPtr >	getDataset_List() const Returns the list of Dataset elements.
void	addToDataset_List(const Inscoper::NBO::DatasetPtr & value, bool validate =true) Adds a new Dataset element to this object.
void	clearDataset_List() Clear the list of Dataset.
void	setFolder_List(const std::vector< Inscoper::NBO::FolderPtr > & value, bool validate =true) Sets the list of Folder elements.
std::vector< Inscoper::NBO::FolderPtr >	getFolder_List() const Returns the list of Folder elements.
void	addToFolder_List(const Inscoper::NBO::FolderPtr & value, bool validate =true) Adds a new Folder element to this object.
void	clearFolder_List() Clear the list of Folder.
void	setExperiment_List(const std::vector< Inscoper::NBO::ExperimentPtr > & value, bool validate =true) Sets the list of Experiment elements.
std::vector< Inscoper::NBO::ExperimentPtr >	getExperiment_List() const Returns the list of Experiment elements.
void	addToExperiment_List(const Inscoper::NBO::ExperimentPtr & value, bool validate =true) Adds a new Experiment element to this object.
void	clearExperiment_List() Clear the list of Experiment.
void	setPlate_List(const std::vector< Inscoper::NBO::PlatePtr > & value, bool validate =true) Sets the list of Plate elements.
std::vector< Inscoper::NBO::PlatePtr >	getPlate_List() const Returns the list of Plate elements.
void	addToPlate_List(const Inscoper::NBO::PlatePtr & value, bool validate =true) Adds a new Plate element to this object.
void	clearPlate_List() Clear the list of Plate.
void	setScreen_List(const std::vector< Inscoper::NBO::ScreenPtr > & value, bool validate =true) Sets the list of Screen elements.
std::vector< Inscoper::NBO::ScreenPtr >	getScreen_List() const Returns the list of Screen elements.
void	addToScreen_List(const Inscoper::NBO::ScreenPtr & value, bool validate =true) Adds a new Screen element to this object.
void	clearScreen_List() Clear the list of Screen.
void	setExperimenter_List(const std::vector< Inscoper::NBO::ExperimenterPtr > & value, bool validate =true) Sets the list of Experimenter elements.
std::vector< Inscoper::NBO::ExperimenterPtr >	getExperimenter_List() const Returns the list of Experimenter elements.
void	addToExperimenter_List(const Inscoper::NBO::ExperimenterPtr & value, bool validate =true) Adds a new Experimenter element to this object.
void	clearExperimenter_List() Clear the list of Experimenter.
void	setExperimenterGroup_List(const std::vector< Inscoper::NBO::ExperimenterGroupPtr > & value, bool validate =true) Sets the list of ExperimenterGroup elements.
std::vector< Inscoper::NBO::ExperimenterGroupPtr >	getExperimenterGroup_List() const Returns the list of ExperimenterGroup elements.
void	addToExperimenterGroup_List(const Inscoper::NBO::ExperimenterGroupPtr & value, bool validate =true) Adds a new ExperimenterGroup element to this object.
void	clearExperimenterGroup_List() Clear the list of ExperimenterGroup.
void	setInstrument_List(const std::vector< Inscoper::NBO::InstrumentPtr > & value, bool validate =true) Sets the list of Instrument elements.
std::vector< Inscoper::NBO::InstrumentPtr >	getInstrument_List() const Returns the list of Instrument elements.
void	addToInstrument_List(const Inscoper::NBO::InstrumentPtr & value, bool validate =true) Adds a new Instrument element to this object.
void	clearInstrument_List() Clear the list of Instrument.
void	setImage_List(const std::vector< Inscoper::NBO::ImagePtr > & value, bool validate =true) Sets the list of Image elements.
std::vector< Inscoper::NBO::ImagePtr >	getImage_List() const Returns the list of Image elements.
void	addToImage_List(const Inscoper::NBO::ImagePtr & value, bool validate =true) Adds a new Image element to this object.
void	clearImage_List() Clear the list of Image.
void	setStructuredAnnotations(const Inscoper::NBO::StructuredAnnotationsPtr & value, bool validate =true) Sets the value of the StructuredAnnotations element.
Inscoper::NBO::StructuredAnnotationsPtr	getStructuredAnnotations() const Returns the value of the StructuredAnnotations element.
void	resetStructuredAnnotations() Resets the StructuredAnnotations element to an unset state.
bool	hasStructuredAnnotations() const Checks whether the optional StructuredAnnotations element is present.
void	setROI_List(const std::vector< Inscoper::NBO::ROIPtr > & value, bool validate =true) Sets the list of ROI elements.
std::vector< Inscoper::NBO::ROIPtr >	getROI_List() const Returns the list of ROI elements.
void	addToROI_List(const Inscoper::NBO::ROIPtr & value, bool validate =true) Adds a new ROI element to this object.
void	clearROI_List() Clear the list of ROI.
std::shared_ptr< InlineOME_Choice_1 >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a InlineOME_Choice_1.

Detailed Description¶

class Inscoper::NBO::OME_Choice::InlineOME_Choice_1;

Represents the XML element OME_Choice_1.

No description available in the XSD standard.

Public Functions Documentation¶

function InlineOME_Choice_1¶

function ~InlineOME_Choice_1¶

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

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

Sets the list of Project elements.

Parameters:

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

No description available in the XSD standard.

function getProject_List¶

function addToProject_List¶

void addToProject_List(
    const Inscoper::NBO::ProjectPtr & value,
    bool validate =true
)

Adds a new Project 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 clearProject_List¶

function setDataset_List¶

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

Sets the list of Dataset elements.

Parameters:

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

No description available in the XSD standard.

function getDataset_List¶

function addToDataset_List¶

void addToDataset_List(
    const Inscoper::NBO::DatasetPtr & value,
    bool validate =true
)

Adds a new Dataset 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 clearDataset_List¶

function setFolder_List¶

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

Sets the list of Folder elements.

Parameters:

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

No description available in the XSD standard.

function getFolder_List¶

function addToFolder_List¶

void addToFolder_List(
    const Inscoper::NBO::FolderPtr & value,
    bool validate =true
)

Adds a new Folder 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 clearFolder_List¶

function setExperiment_List¶

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

Sets the list of Experiment elements.

Parameters:

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

No description available in the XSD standard.

function getExperiment_List¶

std::vector< Inscoper::NBO::ExperimentPtr > getExperiment_List() const

Returns the list of Experiment elements.

Return: The list of Experiment elements

No description available in the XSD standard.

function addToExperiment_List¶

void addToExperiment_List(
    const Inscoper::NBO::ExperimentPtr & value,
    bool validate =true
)

Adds a new Experiment 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 clearExperiment_List¶

function setPlate_List¶

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

Sets the list of Plate elements.

Parameters:

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

No description available in the XSD standard.

function getPlate_List¶

function addToPlate_List¶

void addToPlate_List(
    const Inscoper::NBO::PlatePtr & value,
    bool validate =true
)

Adds a new Plate 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 clearPlate_List¶

function setScreen_List¶

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

Sets the list of Screen elements.

Parameters:

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

No description available in the XSD standard.

function getScreen_List¶

function addToScreen_List¶

void addToScreen_List(
    const Inscoper::NBO::ScreenPtr & value,
    bool validate =true
)

Adds a new Screen 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 clearScreen_List¶

function setExperimenter_List¶

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

Sets the list of Experimenter elements.

Parameters:

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

No description available in the XSD standard.

function getExperimenter_List¶

std::vector< Inscoper::NBO::ExperimenterPtr > getExperimenter_List() const

Returns the list of Experimenter elements.

Return: The list of Experimenter elements

No description available in the XSD standard.

function addToExperimenter_List¶

void addToExperimenter_List(
    const Inscoper::NBO::ExperimenterPtr & value,
    bool validate =true
)

Adds a new Experimenter 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 clearExperimenter_List¶

function setExperimenterGroup_List¶

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

Sets the list of ExperimenterGroup elements.

Parameters:

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

No description available in the XSD standard.

function getExperimenterGroup_List¶

std::vector< Inscoper::NBO::ExperimenterGroupPtr > getExperimenterGroup_List() const

Returns the list of ExperimenterGroup elements.

Return: The list of ExperimenterGroup elements

No description available in the XSD standard.

function addToExperimenterGroup_List¶

void addToExperimenterGroup_List(
    const Inscoper::NBO::ExperimenterGroupPtr & value,
    bool validate =true
)

Adds a new ExperimenterGroup 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 clearExperimenterGroup_List¶

function setInstrument_List¶

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

Sets the list of Instrument elements.

Parameters:

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

No description available in the XSD standard.

function getInstrument_List¶

std::vector< Inscoper::NBO::InstrumentPtr > getInstrument_List() const

Returns the list of Instrument elements.

Return: The list of Instrument elements

No description available in the XSD standard.

function addToInstrument_List¶

void addToInstrument_List(
    const Inscoper::NBO::InstrumentPtr & value,
    bool validate =true
)

Adds a new Instrument 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 clearInstrument_List¶

function setImage_List¶

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

Sets the list of Image elements.

Parameters:

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

No description available in the XSD standard.

function getImage_List¶

function addToImage_List¶

void addToImage_List(
    const Inscoper::NBO::ImagePtr & value,
    bool validate =true
)

Adds a new Image 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 clearImage_List¶

function setStructuredAnnotations¶

void setStructuredAnnotations(
    const Inscoper::NBO::StructuredAnnotationsPtr & value,
    bool validate =true
)

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

Inscoper::NBO::StructuredAnnotationsPtr getStructuredAnnotations() const

Returns the value of the StructuredAnnotations element.

Return: The value of the element

No description available in the XSD standard.

function resetStructuredAnnotations¶

function hasStructuredAnnotations¶

bool hasStructuredAnnotations() const

Checks whether the optional StructuredAnnotations element is present.

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

No description available in the XSD standard.

function setROI_List¶

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

Sets the list of ROI elements.

Parameters:

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

No description available in the XSD standard.

function getROI_List¶

function addToROI_List¶

void addToROI_List(
    const Inscoper::NBO::ROIPtr & value,
    bool validate =true
)

Adds a new ROI 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 clearROI_List¶

function fromBase¶

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

Cast a NBOBaseClass to a InlineOME_Choice_1.

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