com.inscoper.nbo.OpticsHolder_Type
Represents the XML complex type OpticsHolder. More...
Inherits from com.inscoper.nbo.ManufacturerSpec_Type , com.inscoper.nbo.NBOBaseClass
Inherited by com.inscoper.nbo.FilterCube , com.inscoper.nbo.FilterCubeTurret , com.inscoper.nbo.FilterSlider_Type , com.inscoper.nbo.FilterWheel_Type , com.inscoper.nbo.OpticsTurret
Public Functions
Name
synchronized void
delete ()
OpticsHolder_Type ()
String
getTypeName () Returns the class type name.
String
getXMLName () Returns the XML element name corresponding to this class.
ENBOType
getNBOType () Returns the NBO Type corresponding to this class.
NBOBaseClassVector
getChildren () Returns a list of all classes derived from this class.
NBOBaseClassVector
getSubElements () Returns a list of all child elements contained in this class.
void
fromJsonFile (String path, boolean validate) Populates this object from a JSON file.
void
fromJsonFile (String path) Populates this object from a JSON file.
void
fromJsonString (String json_string, boolean validate) Populates this object from a JSON string.
void
fromJsonString (String json_string) Populates this object from a JSON string.
void
fromXmlFile (String path, boolean validate) Populates this object from a XML file.
void
fromXmlFile (String path) Populates this object from a XML file.
void
fromXmlString (String xml_string, boolean validate) Populates this object from a XML string.
void
fromXmlString (String xml_string) Populates this object from a XML string.
void
toXmlFile (String filename, boolean validate) Serializes this object to an XML file.
void
toXmlFile (String filename) Serializes this object to an XML file.
String
toXmlString (boolean validate) Serializes this object to an XML string.
String
toXmlString () Serializes this object to an XML string.
void
setID (LensID_Type value, boolean validate) Sets the value of the ID attribute.
void
setID (LensID_Type value) Sets the value of the ID attribute.
LensID_Type
getID () Returns the value of the ID attribute.
void
resetID () Resets the ID attribute to an unset state.
boolean
hasID () Checks whether the optional ID attribute is present.
void
setName (Denomination_Type value, boolean validate) Sets the value of the Name attribute.
void
setName (Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type
getName () Returns the value of the Name attribute.
void
resetName () Resets the Name attribute to an unset state.
boolean
hasName () Checks whether the optional Name attribute is present.
void
setMotorized (boolean value, boolean validate) Sets the value of the Motorized attribute.
void
setMotorized (boolean value) Sets the value of the Motorized attribute.
boolean
getMotorized () Returns the value of the Motorized attribute.
void
resetMotorized () Resets the Motorized attribute to an unset state.
boolean
hasMotorized () Checks whether the Motorized attribute is present.
void
setResponseTime (float value, boolean validate) Sets the value of the ResponseTime attribute.
void
setResponseTime (float value) Sets the value of the ResponseTime attribute.
float
getResponseTime () Returns the value of the ResponseTime attribute.
void
resetResponseTime () Resets the ResponseTime attribute to an unset state.
boolean
hasResponseTime () Checks whether the ResponseTime attribute is present.
void
setResponseTimeUnit (UnitsTime_Type value, boolean validate) Sets the value of the ResponseTimeUnit attribute.
void
setResponseTimeUnit (UnitsTime_Type value) Sets the value of the ResponseTimeUnit attribute.
UnitsTime_Type
getResponseTimeUnit () Returns the value of the ResponseTimeUnit attribute.
void
resetResponseTimeUnit () Resets the ResponseTimeUnit attribute to an unset state.
boolean
hasResponseTimeUnit () Checks whether the optional ResponseTimeUnit attribute is present.
void
setNrOfSlots (long value, boolean validate) Sets the value of the NrOfSlots attribute.
void
setNrOfSlots (long value) Sets the value of the NrOfSlots attribute.
long
getNrOfSlots () Returns the value of the NrOfSlots attribute.
void
resetNrOfSlots () Resets the NrOfSlots attribute to an unset state.
boolean
hasNrOfSlots () Checks whether the NrOfSlots attribute is present.
void
setAnnotationRef (AnnotationRef value, boolean validate) Sets the value of the AnnotationRef element.
void
setAnnotationRef (AnnotationRef value) Sets the value of the AnnotationRef element.
AnnotationRef
getAnnotationRef () Returns the value of the AnnotationRef element.
void
resetAnnotationRef () Resets the AnnotationRef element to an unset state.
boolean
hasAnnotationRef () Checks whether the optional AnnotationRef element is present.
OpticsHolder_Type
__internal_create (long cPtr, boolean own)
OpticsHolder_Type
fromBase (NBOBaseClass base) Cast a NBOBaseClass to a OpticsHolder_Type .
Protected Functions
Additional inherited members
Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type
Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type
Protected Functions inherited from com.inscoper.nbo.NBOBaseClass
Detailed Description
public class com . 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 delete
public synchronized void delete ()
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.delete
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.delete , com.inscoper.nbo.DichroicFilterWheel.delete , com.inscoper.nbo.EmissionFilterSlider.delete , com.inscoper.nbo.EmissionFilterWheel.delete , com.inscoper.nbo.ExcitationFilterSlider.delete , com.inscoper.nbo.ExcitationFilterWheel.delete , com.inscoper.nbo.FilterCube.delete , com.inscoper.nbo.FilterCubeTurret.delete , com.inscoper.nbo.FilterSlider_Type.delete , com.inscoper.nbo.FilterWheel_Type.delete , com.inscoper.nbo.OpticsTurret.delete
function OpticsHolder_Type function getTypeName
public String getTypeName ()
Returns the class type name.
Return : The class type name
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.getTypeName
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.getTypeName , com.inscoper.nbo.DichroicFilterWheel.getTypeName , com.inscoper.nbo.EmissionFilterSlider.getTypeName , com.inscoper.nbo.EmissionFilterWheel.getTypeName , com.inscoper.nbo.ExcitationFilterSlider.getTypeName , com.inscoper.nbo.ExcitationFilterWheel.getTypeName , com.inscoper.nbo.FilterCube.getTypeName , com.inscoper.nbo.FilterCubeTurret.getTypeName , com.inscoper.nbo.FilterSlider_Type.getTypeName , com.inscoper.nbo.FilterWheel_Type.getTypeName , com.inscoper.nbo.OpticsTurret.getTypeName
function getXMLName
public String getXMLName ()
Returns the XML element name corresponding to this class.
Return : The XML element name
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.getXMLName
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.getXMLName , com.inscoper.nbo.DichroicFilterWheel.getXMLName , com.inscoper.nbo.EmissionFilterSlider.getXMLName , com.inscoper.nbo.EmissionFilterWheel.getXMLName , com.inscoper.nbo.ExcitationFilterSlider.getXMLName , com.inscoper.nbo.ExcitationFilterWheel.getXMLName , com.inscoper.nbo.FilterCube.getXMLName , com.inscoper.nbo.FilterCubeTurret.getXMLName , com.inscoper.nbo.FilterSlider_Type.getXMLName , com.inscoper.nbo.FilterWheel_Type.getXMLName , com.inscoper.nbo.OpticsTurret.getXMLName
function getNBOType
public ENBOType getNBOType ()
Returns the NBO Type corresponding to this class.
Return : The NBO Type value
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.getNBOType
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.getNBOType , com.inscoper.nbo.DichroicFilterWheel.getNBOType , com.inscoper.nbo.EmissionFilterSlider.getNBOType , com.inscoper.nbo.EmissionFilterWheel.getNBOType , com.inscoper.nbo.ExcitationFilterSlider.getNBOType , com.inscoper.nbo.ExcitationFilterWheel.getNBOType , com.inscoper.nbo.FilterCube.getNBOType , com.inscoper.nbo.FilterCubeTurret.getNBOType , com.inscoper.nbo.FilterSlider_Type.getNBOType , com.inscoper.nbo.FilterWheel_Type.getNBOType , com.inscoper.nbo.OpticsTurret.getNBOType
function getChildren
public NBOBaseClassVector getChildren ()
Returns a list of all classes derived from this class.
Return : The list of derived classes
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.getChildren
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.getChildren , com.inscoper.nbo.DichroicFilterWheel.getChildren , com.inscoper.nbo.EmissionFilterSlider.getChildren , com.inscoper.nbo.EmissionFilterWheel.getChildren , com.inscoper.nbo.ExcitationFilterSlider.getChildren , com.inscoper.nbo.ExcitationFilterWheel.getChildren , com.inscoper.nbo.FilterCube.getChildren , com.inscoper.nbo.FilterCubeTurret.getChildren , com.inscoper.nbo.FilterSlider_Type.getChildren , com.inscoper.nbo.FilterWheel_Type.getChildren , com.inscoper.nbo.OpticsTurret.getChildren
function getSubElements
public NBOBaseClassVector getSubElements ()
Returns a list of all child elements contained in this class.
Return : The list of child classes
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.getSubElements
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.getSubElements , com.inscoper.nbo.DichroicFilterWheel.getSubElements , com.inscoper.nbo.EmissionFilterSlider.getSubElements , com.inscoper.nbo.EmissionFilterWheel.getSubElements , com.inscoper.nbo.ExcitationFilterSlider.getSubElements , com.inscoper.nbo.ExcitationFilterWheel.getSubElements , com.inscoper.nbo.FilterCube.getSubElements , com.inscoper.nbo.FilterCubeTurret.getSubElements , com.inscoper.nbo.FilterSlider_Type.getSubElements , com.inscoper.nbo.FilterWheel_Type.getSubElements , com.inscoper.nbo.OpticsTurret.getSubElements
function fromJsonFile
public void fromJsonFile (
String path ,
boolean validate
)
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.
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.fromJsonFile
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.fromJsonFile , com.inscoper.nbo.DichroicFilterWheel.fromJsonFile , com.inscoper.nbo.EmissionFilterSlider.fromJsonFile , com.inscoper.nbo.EmissionFilterWheel.fromJsonFile , com.inscoper.nbo.ExcitationFilterSlider.fromJsonFile , com.inscoper.nbo.ExcitationFilterWheel.fromJsonFile , com.inscoper.nbo.FilterCube.fromJsonFile , com.inscoper.nbo.FilterCubeTurret.fromJsonFile , com.inscoper.nbo.FilterSlider_Type.fromJsonFile , com.inscoper.nbo.FilterWheel_Type.fromJsonFile , com.inscoper.nbo.OpticsTurret.fromJsonFile
function fromJsonFile
public void fromJsonFile (
String path
)
Populates this object from a JSON file.
Parameters :
path The path to the JSON file
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.fromJsonFile
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.fromJsonFile , com.inscoper.nbo.DichroicFilterWheel.fromJsonFile , com.inscoper.nbo.EmissionFilterSlider.fromJsonFile , com.inscoper.nbo.EmissionFilterWheel.fromJsonFile , com.inscoper.nbo.ExcitationFilterSlider.fromJsonFile , com.inscoper.nbo.ExcitationFilterWheel.fromJsonFile , com.inscoper.nbo.FilterCube.fromJsonFile , com.inscoper.nbo.FilterCubeTurret.fromJsonFile , com.inscoper.nbo.FilterSlider_Type.fromJsonFile , com.inscoper.nbo.FilterWheel_Type.fromJsonFile , com.inscoper.nbo.OpticsTurret.fromJsonFile
function fromJsonString
public void fromJsonString (
String json_string ,
boolean validate
)
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.
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.fromJsonString
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.fromJsonString , com.inscoper.nbo.DichroicFilterWheel.fromJsonString , com.inscoper.nbo.EmissionFilterSlider.fromJsonString , com.inscoper.nbo.EmissionFilterWheel.fromJsonString , com.inscoper.nbo.ExcitationFilterSlider.fromJsonString , com.inscoper.nbo.ExcitationFilterWheel.fromJsonString , com.inscoper.nbo.FilterCube.fromJsonString , com.inscoper.nbo.FilterCubeTurret.fromJsonString , com.inscoper.nbo.FilterSlider_Type.fromJsonString , com.inscoper.nbo.FilterWheel_Type.fromJsonString , com.inscoper.nbo.OpticsTurret.fromJsonString
function fromJsonString
public void fromJsonString (
String json_string
)
Populates this object from a JSON string.
Parameters :
json_string The JSON content as a string
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.fromJsonString
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.fromJsonString , com.inscoper.nbo.DichroicFilterWheel.fromJsonString , com.inscoper.nbo.EmissionFilterSlider.fromJsonString , com.inscoper.nbo.EmissionFilterWheel.fromJsonString , com.inscoper.nbo.ExcitationFilterSlider.fromJsonString , com.inscoper.nbo.ExcitationFilterWheel.fromJsonString , com.inscoper.nbo.FilterCube.fromJsonString , com.inscoper.nbo.FilterCubeTurret.fromJsonString , com.inscoper.nbo.FilterSlider_Type.fromJsonString , com.inscoper.nbo.FilterWheel_Type.fromJsonString , com.inscoper.nbo.OpticsTurret.fromJsonString
function fromXmlFile
public void fromXmlFile (
String path ,
boolean validate
)
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.
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.fromXmlFile
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.fromXmlFile , com.inscoper.nbo.DichroicFilterWheel.fromXmlFile , com.inscoper.nbo.EmissionFilterSlider.fromXmlFile , com.inscoper.nbo.EmissionFilterWheel.fromXmlFile , com.inscoper.nbo.ExcitationFilterSlider.fromXmlFile , com.inscoper.nbo.ExcitationFilterWheel.fromXmlFile , com.inscoper.nbo.FilterCube.fromXmlFile , com.inscoper.nbo.FilterCubeTurret.fromXmlFile , com.inscoper.nbo.FilterSlider_Type.fromXmlFile , com.inscoper.nbo.FilterWheel_Type.fromXmlFile , com.inscoper.nbo.OpticsTurret.fromXmlFile
function fromXmlFile
public void fromXmlFile (
String path
)
Populates this object from a XML file.
Parameters :
path The path to the XML file
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.fromXmlFile
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.fromXmlFile , com.inscoper.nbo.DichroicFilterWheel.fromXmlFile , com.inscoper.nbo.EmissionFilterSlider.fromXmlFile , com.inscoper.nbo.EmissionFilterWheel.fromXmlFile , com.inscoper.nbo.ExcitationFilterSlider.fromXmlFile , com.inscoper.nbo.ExcitationFilterWheel.fromXmlFile , com.inscoper.nbo.FilterCube.fromXmlFile , com.inscoper.nbo.FilterCubeTurret.fromXmlFile , com.inscoper.nbo.FilterSlider_Type.fromXmlFile , com.inscoper.nbo.FilterWheel_Type.fromXmlFile , com.inscoper.nbo.OpticsTurret.fromXmlFile
function fromXmlString
public void fromXmlString (
String xml_string ,
boolean validate
)
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.
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.fromXmlString
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.fromXmlString , com.inscoper.nbo.DichroicFilterWheel.fromXmlString , com.inscoper.nbo.EmissionFilterSlider.fromXmlString , com.inscoper.nbo.EmissionFilterWheel.fromXmlString , com.inscoper.nbo.ExcitationFilterSlider.fromXmlString , com.inscoper.nbo.ExcitationFilterWheel.fromXmlString , com.inscoper.nbo.FilterCube.fromXmlString , com.inscoper.nbo.FilterCubeTurret.fromXmlString , com.inscoper.nbo.FilterSlider_Type.fromXmlString , com.inscoper.nbo.FilterWheel_Type.fromXmlString , com.inscoper.nbo.OpticsTurret.fromXmlString
function fromXmlString
public void fromXmlString (
String xml_string
)
Populates this object from a XML string.
Parameters :
xml_string The XML content as a string
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.fromXmlString
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.fromXmlString , com.inscoper.nbo.DichroicFilterWheel.fromXmlString , com.inscoper.nbo.EmissionFilterSlider.fromXmlString , com.inscoper.nbo.EmissionFilterWheel.fromXmlString , com.inscoper.nbo.ExcitationFilterSlider.fromXmlString , com.inscoper.nbo.ExcitationFilterWheel.fromXmlString , com.inscoper.nbo.FilterCube.fromXmlString , com.inscoper.nbo.FilterCubeTurret.fromXmlString , com.inscoper.nbo.FilterSlider_Type.fromXmlString , com.inscoper.nbo.FilterWheel_Type.fromXmlString , com.inscoper.nbo.OpticsTurret.fromXmlString
function toXmlFile
public void toXmlFile (
String filename ,
boolean validate
)
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.
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.toXmlFile
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.toXmlFile , com.inscoper.nbo.DichroicFilterWheel.toXmlFile , com.inscoper.nbo.EmissionFilterSlider.toXmlFile , com.inscoper.nbo.EmissionFilterWheel.toXmlFile , com.inscoper.nbo.ExcitationFilterSlider.toXmlFile , com.inscoper.nbo.ExcitationFilterWheel.toXmlFile , com.inscoper.nbo.FilterCube.toXmlFile , com.inscoper.nbo.FilterCubeTurret.toXmlFile , com.inscoper.nbo.FilterSlider_Type.toXmlFile , com.inscoper.nbo.FilterWheel_Type.toXmlFile , com.inscoper.nbo.OpticsTurret.toXmlFile
function toXmlFile
public void toXmlFile (
String filename
)
Serializes this object to an XML file.
Parameters :
filename The path to the output XML file
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.toXmlFile
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.toXmlFile , com.inscoper.nbo.DichroicFilterWheel.toXmlFile , com.inscoper.nbo.EmissionFilterSlider.toXmlFile , com.inscoper.nbo.EmissionFilterWheel.toXmlFile , com.inscoper.nbo.ExcitationFilterSlider.toXmlFile , com.inscoper.nbo.ExcitationFilterWheel.toXmlFile , com.inscoper.nbo.FilterCube.toXmlFile , com.inscoper.nbo.FilterCubeTurret.toXmlFile , com.inscoper.nbo.FilterSlider_Type.toXmlFile , com.inscoper.nbo.FilterWheel_Type.toXmlFile , com.inscoper.nbo.OpticsTurret.toXmlFile
function toXmlString
public String toXmlString (
boolean validate
)
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
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.toXmlString
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.toXmlString , com.inscoper.nbo.DichroicFilterWheel.toXmlString , com.inscoper.nbo.EmissionFilterSlider.toXmlString , com.inscoper.nbo.EmissionFilterWheel.toXmlString , com.inscoper.nbo.ExcitationFilterSlider.toXmlString , com.inscoper.nbo.ExcitationFilterWheel.toXmlString , com.inscoper.nbo.FilterCube.toXmlString , com.inscoper.nbo.FilterCubeTurret.toXmlString , com.inscoper.nbo.FilterSlider_Type.toXmlString , com.inscoper.nbo.FilterWheel_Type.toXmlString , com.inscoper.nbo.OpticsTurret.toXmlString
function toXmlString
public String toXmlString ()
Serializes this object to an XML string.
Return : A string containing the XML representation of this object
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.toXmlString
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.toXmlString , com.inscoper.nbo.DichroicFilterWheel.toXmlString , com.inscoper.nbo.EmissionFilterSlider.toXmlString , com.inscoper.nbo.EmissionFilterWheel.toXmlString , com.inscoper.nbo.ExcitationFilterSlider.toXmlString , com.inscoper.nbo.ExcitationFilterWheel.toXmlString , com.inscoper.nbo.FilterCube.toXmlString , com.inscoper.nbo.FilterCubeTurret.toXmlString , com.inscoper.nbo.FilterSlider_Type.toXmlString , com.inscoper.nbo.FilterWheel_Type.toXmlString , com.inscoper.nbo.OpticsTurret.toXmlString
function setID
public void setID (
LensID_Type value ,
boolean validate
)
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 setID
public void setID (
LensID_Type value
)
Sets the value of the ID attribute.
Parameters :
A Unique Identifier for this component.
function getID
public LensID_Type getID ()
Returns the value of the ID attribute.
Return : The value of the attribute
A Unique Identifier for this component.
function resetID
Resets the ID attribute to an unset state.
A Unique Identifier for this component.
function hasID
Checks whether the optional ID attribute is present.
Return : true if the optional attribute has been set, false otherwise
A Unique Identifier for this component.
function setName
public void setName (
Denomination_Type value ,
boolean validate
)
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 setName
public void setName (
Denomination_Type value
)
Sets the value of the Name attribute.
Parameters :
A User-defined Name for this component.
function getName
public Denomination_Type getName ()
Returns the value of the Name attribute.
Return : The value of the attribute
A User-defined Name for this component.
function resetName
Resets the Name attribute to an unset state.
A User-defined Name for this component.
function hasName
Checks whether the optional Name attribute is present.
Return : true if the optional attribute has been set, false otherwise
A User-defined Name for this component.
function setMotorized
public void setMotorized (
boolean value ,
boolean validate
)
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 setMotorized
public void setMotorized (
boolean value
)
Sets the value of the Motorized attribute.
Parameters :
This field describes whether this device is Motor (True) or Manually (False) operated.
function getMotorized
public boolean getMotorized ()
Returns the value of the Motorized attribute.
Return : The value of the attribute
This field describes whether this device is Motor (True) or Manually (False) operated.
function resetMotorized
public void resetMotorized ()
Resets the Motorized attribute to an unset state.
This field describes whether this device is Motor (True) or Manually (False) operated.
function hasMotorized
public boolean hasMotorized ()
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
public void setResponseTime (
float value ,
boolean validate
)
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 setResponseTime
public void setResponseTime (
float value
)
Sets the value of the ResponseTime attribute.
Parameters :
This field records the time it takes for this Shutter to open and close, according to the Manufacturer.
function getResponseTime
public float getResponseTime ()
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
public void 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.
function hasResponseTime
public boolean hasResponseTime ()
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
public void setResponseTimeUnit (
UnitsTime_Type value ,
boolean validate
)
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 setResponseTimeUnit
public void setResponseTimeUnit (
UnitsTime_Type value
)
Sets the value of the ResponseTimeUnit attribute.
Parameters :
No description available in the XSD standard.
function getResponseTimeUnit
public UnitsTime_Type getResponseTimeUnit ()
Returns the value of the ResponseTimeUnit attribute.
Return : The value of the attribute
No description available in the XSD standard.
function resetResponseTimeUnit
public void resetResponseTimeUnit ()
Resets the ResponseTimeUnit attribute to an unset state.
No description available in the XSD standard.
function hasResponseTimeUnit
public boolean hasResponseTimeUnit ()
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
public void setNrOfSlots (
long value ,
boolean validate
)
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 setNrOfSlots
public void setNrOfSlots (
long value
)
Sets the value of the NrOfSlots attribute.
Parameters :
This field records how many Slots this Optics Holder has.
function getNrOfSlots
public long getNrOfSlots ()
Returns the value of the NrOfSlots attribute.
Return : The value of the attribute
This field records how many Slots this Optics Holder has.
function resetNrOfSlots
public void resetNrOfSlots ()
Resets the NrOfSlots attribute to an unset state.
This field records how many Slots this Optics Holder has.
function hasNrOfSlots
public boolean hasNrOfSlots ()
Checks whether the NrOfSlots attribute is present.
Return : true if the attribute has been set, false otherwise
This field records how many Slots this Optics Holder has.
function setAnnotationRef
public void setAnnotationRef (
AnnotationRef value ,
boolean validate
)
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 setAnnotationRef
public void setAnnotationRef (
AnnotationRef value
)
Sets the value of the AnnotationRef element.
Parameters :
No description available in the XSD standard.
function getAnnotationRef
public AnnotationRef getAnnotationRef ()
Returns the value of the AnnotationRef element.
Return : The value of the element
No description available in the XSD standard.
function resetAnnotationRef
public void resetAnnotationRef ()
Resets the AnnotationRef element to an unset state.
No description available in the XSD standard.
function hasAnnotationRef
public boolean hasAnnotationRef ()
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 __internal_create
public static OpticsHolder_Type __internal_create (
long cPtr ,
boolean own
)
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.__internal_create
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.__internal_create , com.inscoper.nbo.DichroicFilterWheel.__internal_create , com.inscoper.nbo.EmissionFilterSlider.__internal_create , com.inscoper.nbo.EmissionFilterWheel.__internal_create , com.inscoper.nbo.ExcitationFilterSlider.__internal_create , com.inscoper.nbo.ExcitationFilterWheel.__internal_create , com.inscoper.nbo.FilterCube.__internal_create , com.inscoper.nbo.FilterCubeTurret.__internal_create , com.inscoper.nbo.FilterSlider_Type.__internal_create , com.inscoper.nbo.FilterWheel_Type.__internal_create , com.inscoper.nbo.OpticsTurret.__internal_create
function fromBase
public static OpticsHolder_Type fromBase (
NBOBaseClass 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
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.fromBase
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.fromBase , com.inscoper.nbo.DichroicFilterWheel.fromBase , com.inscoper.nbo.EmissionFilterSlider.fromBase , com.inscoper.nbo.EmissionFilterWheel.fromBase , com.inscoper.nbo.ExcitationFilterSlider.fromBase , com.inscoper.nbo.ExcitationFilterWheel.fromBase , com.inscoper.nbo.FilterCube.fromBase , com.inscoper.nbo.FilterCubeTurret.fromBase , com.inscoper.nbo.FilterSlider_Type.fromBase , com.inscoper.nbo.FilterWheel_Type.fromBase , com.inscoper.nbo.OpticsTurret.fromBase
Protected Functions Documentation
function OpticsHolder_Type function swigSetCMemOwn
protected void swigSetCMemOwn (
boolean own
)
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.swigSetCMemOwn
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.swigSetCMemOwn , com.inscoper.nbo.DichroicFilterWheel.swigSetCMemOwn , com.inscoper.nbo.EmissionFilterSlider.swigSetCMemOwn , com.inscoper.nbo.EmissionFilterWheel.swigSetCMemOwn , com.inscoper.nbo.ExcitationFilterSlider.swigSetCMemOwn , com.inscoper.nbo.ExcitationFilterWheel.swigSetCMemOwn , com.inscoper.nbo.FilterCube.swigSetCMemOwn , com.inscoper.nbo.FilterCubeTurret.swigSetCMemOwn , com.inscoper.nbo.FilterSlider_Type.swigSetCMemOwn , com.inscoper.nbo.FilterWheel_Type.swigSetCMemOwn , com.inscoper.nbo.OpticsTurret.swigSetCMemOwn
function finalize
protected void finalize ()
Reimplements : com.inscoper.nbo.ManufacturerSpec_Type.finalize
Reimplemented by : com.inscoper.nbo.DichroicFilterSlider.finalize , com.inscoper.nbo.DichroicFilterWheel.finalize , com.inscoper.nbo.EmissionFilterSlider.finalize , com.inscoper.nbo.EmissionFilterWheel.finalize , com.inscoper.nbo.ExcitationFilterSlider.finalize , com.inscoper.nbo.ExcitationFilterWheel.finalize , com.inscoper.nbo.FilterCube.finalize , com.inscoper.nbo.FilterCubeTurret.finalize , com.inscoper.nbo.FilterSlider_Type.finalize , com.inscoper.nbo.FilterWheel_Type.finalize , com.inscoper.nbo.OpticsTurret.finalize
function getCPtr
protected static long getCPtr (
OpticsHolder_Type obj
)
Updated on 2026-10-26 at 15:27:47 +0100