OpticsHolder_Type

Bases: ManufacturerSpec_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.

getTypeName()

Returns the class type name.

Returns:

Type	Description
string	The class type name

getXMLName()

Returns the XML element name corresponding to this class.

Returns:

Type	Description
string	The XML element name

getNBOType()

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
int	The NBO Type value

getChildren()

Returns a list of all classes derived from this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of derived classes

getSubElements()

Returns a list of all child elements contained in this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of child classes

fromJsonFile(path)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required

toXmlString()

Serializes this object to an XML string.

Returns:

Type	Description
string	A string containing the XML representation of this object

setID(value)

Sets the value of the ID attribute.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
value	LensID_Type	The value to set	required

getID()

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
LensID_Type	The value of the attribute

resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

hasID()

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setName(value)

Sets the value of the Name attribute.

A User-defined Name for this component.

Parameters:

Name	Type	Description	Default
value	Denomination_Type	The value to set	required

getName()

Returns the value of the Name attribute.

A User-defined Name for this component.

Returns:

Type	Description
Denomination_Type	The value of the attribute

resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

hasName()

Checks whether the optional Name attribute is present.

A User-defined Name for this component.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setMotorized(value)

Sets the value of the Motorized attribute.

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

Parameters:

Name	Type	Description	Default
value	boolean	The value to set	required

getMotorized()

Returns the value of the Motorized attribute.

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

Returns:

Type	Description
boolean	The value of the attribute

resetMotorized()

Resets the Motorized attribute to an unset state.

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

hasMotorized()

Checks whether the optional Motorized attribute is present.

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

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setResponseTime(value)

Sets the value of the ResponseTime attribute.

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

Parameters:

Name	Type	Description	Default
value	float	The value to set	required

getResponseTime()

Returns the value of the ResponseTime attribute.

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

Returns:

Type	Description
float	The value of the attribute

resetResponseTime()

Resets the ResponseTime attribute to an unset state.

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

hasResponseTime()

Checks whether the optional ResponseTime attribute is present.

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

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setResponseTimeUnit(value)

Sets the value of the ResponseTimeUnit attribute.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	UnitsTime_Type	The value to set	required

getResponseTimeUnit()

Returns the value of the ResponseTimeUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsTime_Type	The value of the attribute

resetResponseTimeUnit()

Resets the ResponseTimeUnit attribute to an unset state.

No description available in the XSD standard.

hasResponseTimeUnit()

Checks whether the optional ResponseTimeUnit attribute is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setNrOfSlots(value)

Sets the value of the NrOfSlots attribute.

This field records how many Slots this Optics Holder has.

Parameters:

Name	Type	Description	Default
value	int	The value to set	required

getNrOfSlots()

Returns the value of the NrOfSlots attribute.

This field records how many Slots this Optics Holder has.

Returns:

Type	Description
int	The value of the attribute

resetNrOfSlots()

Resets the NrOfSlots attribute to an unset state.

This field records how many Slots this Optics Holder has.

hasNrOfSlots()

Checks whether the optional NrOfSlots attribute is present.

This field records how many Slots this Optics Holder has.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setAnnotationRef(value)

Sets the value of the AnnotationRef element.

No description available in the XSD standard.

Parameters:

Name	Type	Description	Default
value	AnnotationRef	The value to set	required

getAnnotationRef()

Returns the value of the AnnotationRef element.

No description available in the XSD standard.

Returns:

Type	Description
AnnotationRef	The value of the element

resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

No description available in the XSD standard.

hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

No description available in the XSD standard.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise