Inscoper::NBO::AcquisitionSoftware¶

Represents the XML element AcquisitionSoftware. More...

#include <AcquisitionSoftware.h>

Inherits from Inscoper::NBO::Software_Type, NBOBaseClass

Public Functions¶

	Name
	AcquisitionSoftware()
	~AcquisitionSoftware()
virtual 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.
std::shared_ptr< AcquisitionSoftware >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a AcquisitionSoftware.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::Software_Type

	Name
	Software_Type()
	~Software_Type()
void	setID(const Inscoper::NBO::LSID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LSID_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	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	setVersion(const std::string & value, bool validate =true) Sets the value of the Version attribute.
std::string	getVersion() const Returns the value of the Version attribute.
void	resetVersion() Resets the Version attribute to an unset state.
bool	hasVersion() const Checks whether the Version attribute is present.
void	setDeveloper(const std::string & value, bool validate =true) Sets the value of the Developer attribute.
std::string	getDeveloper() const Returns the value of the Developer attribute.
void	resetDeveloper() Resets the Developer attribute to an unset state.
bool	hasDeveloper() const Checks whether the Developer attribute is present.
void	setWebsiteURL(const std::string & value, bool validate =true) Sets the value of the WebsiteURL attribute.
std::string	getWebsiteURL() const Returns the value of the WebsiteURL attribute.
void	resetWebsiteURL() Resets the WebsiteURL attribute to an unset state.
bool	hasWebsiteURL() const Checks whether the WebsiteURL attribute is present.
void	setPrimaryPublicationID(const std::string & value, bool validate =true) Sets the value of the PrimaryPublicationID attribute.
std::string	getPrimaryPublicationID() const Returns the value of the PrimaryPublicationID attribute.
void	resetPrimaryPublicationID() Resets the PrimaryPublicationID attribute to an unset state.
bool	hasPrimaryPublicationID() const Checks whether the PrimaryPublicationID attribute is present.
void	setOpenSource(const bool & value, bool validate =true) Sets the value of the OpenSource attribute.
bool	getOpenSource() const Returns the value of the OpenSource attribute.
void	resetOpenSource() Resets the OpenSource attribute to an unset state.
bool	hasOpenSource() const Checks whether the OpenSource attribute is present.
void	setMacro(const bool & value, bool validate =true) Sets the value of the Macro attribute.
bool	getMacro() const Returns the value of the Macro attribute.
void	resetMacro() Resets the Macro attribute to an unset state.
bool	hasMacro() const Checks whether the Macro attribute is present.
void	setBuild(const std::string & value, bool validate =true) Sets the value of the Build attribute.
std::string	getBuild() const Returns the value of the Build attribute.
void	resetBuild() Resets the Build attribute to an unset state.
bool	hasBuild() const Checks whether the Build attribute is present.
void	setPatch(const std::string & value, bool validate =true) Sets the value of the Patch attribute.
std::string	getPatch() const Returns the value of the Patch attribute.
void	resetPatch() Resets the Patch attribute to an unset state.
bool	hasPatch() const Checks whether the Patch attribute is present.
void	setReleaseDate(const std::string & value, bool validate =true) Sets the value of the ReleaseDate attribute.
std::string	getReleaseDate() const Returns the value of the ReleaseDate attribute.
void	resetReleaseDate() Resets the ReleaseDate attribute to an unset state.
bool	hasReleaseDate() const Checks whether the ReleaseDate attribute is present.
void	setLanguage(const std::string & value, bool validate =true) Sets the value of the Language attribute.
std::string	getLanguage() const Returns the value of the Language attribute.
void	resetLanguage() Resets the Language attribute to an unset state.
bool	hasLanguage() const Checks whether the Language attribute is present.
void	setSoftwareModuleRef_List(const std::vector< Inscoper::NBO::SoftwareModuleRefPtr > & value, bool validate =true) Sets the list of SoftwareModuleRef elements.
std::vector< Inscoper::NBO::SoftwareModuleRefPtr >	getSoftwareModuleRef_List() const Returns the list of SoftwareModuleRef elements.
void	addToSoftwareModuleRef_List(const Inscoper::NBO::SoftwareModuleRefPtr & value, bool validate =true) Adds a new SoftwareModuleRef element to this object.
void	clearSoftwareModuleRef_List() Clear the list of SoftwareModuleRef.
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.
const std::set< std::string > &	getNameAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getVersionAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getDeveloperAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getWebsiteURLAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getPrimaryPublicationIDAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getBuildAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getPatchAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getReleaseDateAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getLanguageAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::AcquisitionSoftware;

Represents the XML element AcquisitionSoftware.

This element represents a commercial, or open-source Software, script, macro, plugin or module utilized for driving this Instrument during Image Acquisition.

Public Functions Documentation¶

function AcquisitionSoftware¶

function ~AcquisitionSoftware¶

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

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

Cast a NBOBaseClass to a AcquisitionSoftware.

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