Inscoper::NBO::OpticsHolder_Type¶

Represents the XML complex type OpticsHolder. More...

#include <OpticsHolder_Type.h>

Inherits from Inscoper::NBO::ManufacturerSpec_Type, NBOBaseClass

Inherited by Inscoper::NBO::FilterCube, Inscoper::NBO::FilterCubeTurret, Inscoper::NBO::FilterSlider_Type, Inscoper::NBO::FilterWheel_Type, Inscoper::NBO::OpticsTurret

Public Functions¶

	Name
	OpticsHolder_Type()
	~OpticsHolder_Type()
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.
void	setID(const Inscoper::NBO::LensID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
LensID_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 Inscoper::NBO::Denomination_TypePtr & value, bool validate =true) Sets the value of the Name attribute.
Denomination_TypePtr	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 optional Name attribute is present.
void	setMotorized(const bool & value, bool validate =true) Sets the value of the Motorized attribute.
bool	getMotorized() const Returns the value of the Motorized attribute.
void	resetMotorized() Resets the Motorized attribute to an unset state.
bool	hasMotorized() const Checks whether the Motorized attribute is present.
void	setResponseTime(const float & value, bool validate =true) Sets the value of the ResponseTime attribute.
float	getResponseTime() const Returns the value of the ResponseTime attribute.
void	resetResponseTime() Resets the ResponseTime attribute to an unset state.
bool	hasResponseTime() const Checks whether the ResponseTime attribute is present.
void	setResponseTimeUnit(const Inscoper::NBO::UnitsTime_TypePtr & value, bool validate =true) Sets the value of the ResponseTimeUnit attribute.
UnitsTime_TypePtr	getResponseTimeUnit() const Returns the value of the ResponseTimeUnit attribute.
void	resetResponseTimeUnit() Resets the ResponseTimeUnit attribute to an unset state.
bool	hasResponseTimeUnit() const Checks whether the optional ResponseTimeUnit attribute is present.
void	setNrOfSlots(const long long & value, bool validate =true) Sets the value of the NrOfSlots attribute.
long long	getNrOfSlots() const Returns the value of the NrOfSlots attribute.
void	resetNrOfSlots() Resets the NrOfSlots attribute to an unset state.
bool	hasNrOfSlots() const Checks whether the NrOfSlots attribute is present.
void	setAnnotationRef(const Inscoper::NBO::AnnotationRefPtr & value, bool validate =true) Sets the value of the AnnotationRef element.
Inscoper::NBO::AnnotationRefPtr	getAnnotationRef() const Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
bool	hasAnnotationRef() const Checks whether the optional AnnotationRef element is present.
std::shared_ptr< OpticsHolder_Type >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a OpticsHolder_Type.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
	~ManufacturerSpec_Type()
void	setManufacturer(const std::string & value, bool validate =true) Sets the value of the Manufacturer attribute.
std::string	getManufacturer() const Returns the value of the Manufacturer attribute.
void	resetManufacturer() Resets the Manufacturer attribute to an unset state.
bool	hasManufacturer() const Checks whether the Manufacturer attribute is present.
void	setModel(const std::string & value, bool validate =true) Sets the value of the Model attribute.
std::string	getModel() const Returns the value of the Model attribute.
void	resetModel() Resets the Model attribute to an unset state.
bool	hasModel() const Checks whether the Model attribute is present.
void	setCatalogNumber(const std::string & value, bool validate =true) Sets the value of the CatalogNumber attribute.
std::string	getCatalogNumber() const Returns the value of the CatalogNumber attribute.
void	resetCatalogNumber() Resets the CatalogNumber attribute to an unset state.
bool	hasCatalogNumber() const Checks whether the CatalogNumber attribute is present.
void	setLotNumber(const std::string & value, bool validate =true) Sets the value of the LotNumber attribute.
std::string	getLotNumber() const Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
bool	hasLotNumber() const Checks whether the LotNumber attribute is present.
void	setMapAnnotation_List(const std::vector< Inscoper::NBO::MapAnnotationPtr > & value, bool validate =true) Sets the list of MapAnnotation elements.
std::vector< Inscoper::NBO::MapAnnotationPtr >	getMapAnnotation_List() const Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(const Inscoper::NBO::MapAnnotationPtr & value, bool validate =true) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(const Inscoper::NBO::FileAnnotation_TypePtr & value, bool validate =true) Sets the value of the SpecsFile element.
Inscoper::NBO::FileAnnotation_TypePtr	getSpecsFile() const Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
bool	hasSpecsFile() const Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(const std::vector< Inscoper::NBO::AdditionalVendorInformationPtr > & value, bool validate =true) Sets the list of AdditionalVendorInformation elements.
std::vector< Inscoper::NBO::AdditionalVendorInformationPtr >	getAdditionalVendorInformation_List() const Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(const Inscoper::NBO::AdditionalVendorInformationPtr & value, bool validate =true) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.
const std::set< std::string > &	getManufacturerAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getModelAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getCatalogNumberAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getLotNumberAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::OpticsHolder_Type;

Represents the XML complex type OpticsHolder.

This element represents a Holder for Filters, Dichroic and other Optical Element that is associated with this Instrument. These Holders come in different arrangements such as Cubes, Sliders, Turrets, and Wheels. While some of these Holders, such as Filter Cubes, might be pre-assebled by the Manufacturer and pruchased as a whole, in the majority of cases they are assembled on site depending on the needs of the user.

Public Functions Documentation¶

function OpticsHolder_Type¶

function ~OpticsHolder_Type¶

function getTypeName¶

virtual std::string getTypeName() const override

Returns the class type name.

Return: The class type name

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

void setID(
    const Inscoper::NBO::LensID_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.

A Unique Identifier for this component.

function getID¶

function resetID¶

function hasID¶

function setName¶

void setName(
    const Inscoper::NBO::Denomination_TypePtr & 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.

A User-defined Name for this component.

function getName¶

function resetName¶

function hasName¶

function setMotorized¶

void setMotorized(
    const bool & value,
    bool validate =true
)

Sets the value of the Motorized attribute.

Parameters:

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

This field describes whether this device is Motor (True) or Manually (False) operated.

function getMotorized¶

function resetMotorized¶

function hasMotorized¶

bool hasMotorized() const

Checks whether the Motorized attribute is present.

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

This field describes whether this device is Motor (True) or Manually (False) operated.

function setResponseTime¶

void setResponseTime(
    const float & value,
    bool validate =true
)

Sets the value of the ResponseTime attribute.

Parameters:

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

This field records the time it takes for this Shutter to open and close, according to the Manufacturer.

function getResponseTime¶

float getResponseTime() const

Returns the value of the ResponseTime attribute.

Return: The value of the attribute

This field records the time it takes for this Shutter to open and close, according to the Manufacturer.

function resetResponseTime¶

function hasResponseTime¶

bool hasResponseTime() const

Checks whether the ResponseTime attribute is present.

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

This field records the time it takes for this Shutter to open and close, according to the Manufacturer.

function setResponseTimeUnit¶

void setResponseTimeUnit(
    const Inscoper::NBO::UnitsTime_TypePtr & value,
    bool validate =true
)

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

function resetResponseTimeUnit¶

function hasResponseTimeUnit¶

bool hasResponseTimeUnit() const

Checks whether the optional ResponseTimeUnit attribute is present.

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

No description available in the XSD standard.

function setNrOfSlots¶

void setNrOfSlots(
    const long long & value,
    bool validate =true
)

Sets the value of the NrOfSlots attribute.

Parameters:

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

This field records how many Slots this Optics Holder has.

function getNrOfSlots¶

function resetNrOfSlots¶

function hasNrOfSlots¶

function setAnnotationRef¶

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

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

function resetAnnotationRef¶

function hasAnnotationRef¶

bool hasAnnotationRef() const

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

Cast a NBOBaseClass to a OpticsHolder_Type.

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