com.inscoper.nbo.MirroringDevice_Type¶

Represents the XML complex type MirroringDevice. More...

Inherits from com.inscoper.nbo.ManufacturerSpec_Type, com.inscoper.nbo.NBOBaseClass

Inherited by com.inscoper.nbo.BeamSplitter, com.inscoper.nbo.Dichroic_Type, com.inscoper.nbo.ReflectingMirror

Public Functions¶

	Name
synchronized void	delete()
	MirroringDevice_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(MirrorID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(MirrorID_Type value) Sets the value of the ID attribute.
MirrorID_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	setOpticsHolderPosition(String value, boolean validate) Sets the value of the OpticsHolderPosition attribute.
void	setOpticsHolderPosition(String value) Sets the value of the OpticsHolderPosition attribute.
String	getOpticsHolderPosition() Returns the value of the OpticsHolderPosition attribute.
void	resetOpticsHolderPosition() Resets the OpticsHolderPosition attribute to an unset state.
boolean	hasOpticsHolderPosition() Checks whether the OpticsHolderPosition attribute is present.
void	setMirrorType(MirrorType_Type value, boolean validate) Sets the value of the MirrorType attribute.
void	setMirrorType(MirrorType_Type value) Sets the value of the MirrorType attribute.
MirrorType_Type	getMirrorType() Returns the value of the MirrorType attribute.
void	resetMirrorType() Resets the MirrorType attribute to an unset state.
boolean	hasMirrorType() Checks whether the optional MirrorType attribute is present.
void	setGeometry(MirrorGeometry_Type value, boolean validate) Sets the value of the Geometry attribute.
void	setGeometry(MirrorGeometry_Type value) Sets the value of the Geometry attribute.
MirrorGeometry_Type	getGeometry() Returns the value of the Geometry attribute.
void	resetGeometry() Resets the Geometry attribute to an unset state.
boolean	hasGeometry() Checks whether the optional Geometry attribute is present.
void	setDiameter(float value, boolean validate) Sets the value of the Diameter attribute.
void	setDiameter(float value) Sets the value of the Diameter attribute.
float	getDiameter() Returns the value of the Diameter attribute.
void	resetDiameter() Resets the Diameter attribute to an unset state.
boolean	hasDiameter() Checks whether the Diameter attribute is present.
void	setDiameterUnit(UnitsLength_Type value, boolean validate) Sets the value of the DiameterUnit attribute.
void	setDiameterUnit(UnitsLength_Type value) Sets the value of the DiameterUnit attribute.
UnitsLength_Type	getDiameterUnit() Returns the value of the DiameterUnit attribute.
void	resetDiameterUnit() Resets the DiameterUnit attribute to an unset state.
boolean	hasDiameterUnit() Checks whether the optional DiameterUnit attribute is present.
void	setRadiusOfCurvature(float value, boolean validate) Sets the value of the RadiusOfCurvature attribute.
void	setRadiusOfCurvature(float value) Sets the value of the RadiusOfCurvature attribute.
float	getRadiusOfCurvature() Returns the value of the RadiusOfCurvature attribute.
void	resetRadiusOfCurvature() Resets the RadiusOfCurvature attribute to an unset state.
boolean	hasRadiusOfCurvature() Checks whether the RadiusOfCurvature attribute is present.
void	setRadiusOfCurvatureUnit(UnitsLength_Type value, boolean validate) Sets the value of the RadiusOfCurvatureUnit attribute.
void	setRadiusOfCurvatureUnit(UnitsLength_Type value) Sets the value of the RadiusOfCurvatureUnit attribute.
UnitsLength_Type	getRadiusOfCurvatureUnit() Returns the value of the RadiusOfCurvatureUnit attribute.
void	resetRadiusOfCurvatureUnit() Resets the RadiusOfCurvatureUnit attribute to an unset state.
boolean	hasRadiusOfCurvatureUnit() Checks whether the optional RadiusOfCurvatureUnit attribute is present.
void	setAngleOfIncidence(float value, boolean validate) Sets the value of the AngleOfIncidence attribute.
void	setAngleOfIncidence(float value) Sets the value of the AngleOfIncidence attribute.
float	getAngleOfIncidence() Returns the value of the AngleOfIncidence attribute.
void	resetAngleOfIncidence() Resets the AngleOfIncidence attribute to an unset state.
boolean	hasAngleOfIncidence() Checks whether the AngleOfIncidence attribute is present.
void	setAngleOfIncidenceUnit(UnitsAngle_Type value, boolean validate) Sets the value of the AngleOfIncidenceUnit attribute.
void	setAngleOfIncidenceUnit(UnitsAngle_Type value) Sets the value of the AngleOfIncidenceUnit attribute.
UnitsAngle_Type	getAngleOfIncidenceUnit() Returns the value of the AngleOfIncidenceUnit attribute.
void	resetAngleOfIncidenceUnit() Resets the AngleOfIncidenceUnit attribute to an unset state.
boolean	hasAngleOfIncidenceUnit() Checks whether the optional AngleOfIncidenceUnit attribute is present.
void	setSubstrateType(String value, boolean validate) Sets the value of the SubstrateType attribute.
void	setSubstrateType(String value) Sets the value of the SubstrateType attribute.
String	getSubstrateType() Returns the value of the SubstrateType attribute.
void	resetSubstrateType() Resets the SubstrateType attribute to an unset state.
boolean	hasSubstrateType() Checks whether the SubstrateType attribute is present.
void	setSubstrateMaterial(OpticalMaterialName_Type value, boolean validate) Sets the value of the SubstrateMaterial attribute.
void	setSubstrateMaterial(OpticalMaterialName_Type value) Sets the value of the SubstrateMaterial attribute.
OpticalMaterialName_Type	getSubstrateMaterial() Returns the value of the SubstrateMaterial attribute.
void	resetSubstrateMaterial() Resets the SubstrateMaterial attribute to an unset state.
boolean	hasSubstrateMaterial() Checks whether the optional SubstrateMaterial attribute is present.
void	setGlassCode(String value, boolean validate) Sets the value of the GlassCode attribute.
void	setGlassCode(String value) Sets the value of the GlassCode attribute.
String	getGlassCode() Returns the value of the GlassCode attribute.
void	resetGlassCode() Resets the GlassCode attribute to an unset state.
boolean	hasGlassCode() Checks whether the GlassCode 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.
MirroringDevice_Type	__internal_create(long cPtr, boolean own)
MirroringDevice_Type	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a MirroringDevice_Type.
StringSet	getOpticsHolderPositionAllowedValues() Returns the allowed values for this attribut.
StringSet	getAngleOfIncidenceUnitAllowedValues() Returns the allowed values for this attribut.
StringSet	getSubstrateTypeAllowedValues() Returns the allowed values for this attribut.
StringSet	getGlassCodeAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

	Name
	MirroringDevice_Type(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(MirroringDevice_Type obj)

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
void	setManufacturer(String value, boolean validate) Sets the value of the Manufacturer attribute.
void	setManufacturer(String value) Sets the value of the Manufacturer attribute.
String	getManufacturer() Returns the value of the Manufacturer attribute.
void	resetManufacturer() Resets the Manufacturer attribute to an unset state.
boolean	hasManufacturer() Checks whether the Manufacturer attribute is present.
void	setModel(String value, boolean validate) Sets the value of the Model attribute.
void	setModel(String value) Sets the value of the Model attribute.
String	getModel() Returns the value of the Model attribute.
void	resetModel() Resets the Model attribute to an unset state.
boolean	hasModel() Checks whether the Model attribute is present.
void	setCatalogNumber(String value, boolean validate) Sets the value of the CatalogNumber attribute.
void	setCatalogNumber(String value) Sets the value of the CatalogNumber attribute.
String	getCatalogNumber() Returns the value of the CatalogNumber attribute.
void	resetCatalogNumber() Resets the CatalogNumber attribute to an unset state.
boolean	hasCatalogNumber() Checks whether the CatalogNumber attribute is present.
void	setLotNumber(String value, boolean validate) Sets the value of the LotNumber attribute.
void	setLotNumber(String value) Sets the value of the LotNumber attribute.
String	getLotNumber() Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
boolean	hasLotNumber() Checks whether the LotNumber attribute is present.
void	setMapAnnotation_List(MapAnnotationVector value, boolean validate) Sets the list of MapAnnotation elements.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value, boolean validate) Adds a new MapAnnotation element to this object.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(FileAnnotation_Type value, boolean validate) Sets the value of the SpecsFile element.
void	setSpecsFile(FileAnnotation_Type value) Sets the value of the SpecsFile element.
FileAnnotation_Type	getSpecsFile() Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
boolean	hasSpecsFile() Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value, boolean validate) Sets the list of AdditionalVendorInformation elements.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value, boolean validate) Adds a new AdditionalVendorInformation element to this object.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.
StringSet	getManufacturerAllowedValues() Returns the allowed values for this attribut.
StringSet	getModelAllowedValues() Returns the allowed values for this attribut.
StringSet	getCatalogNumberAllowedValues() Returns the allowed values for this attribut.
StringSet	getLotNumberAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.MirroringDevice_Type;

Represents the XML complex type MirroringDevice.

This element describes a Mirror positioned in the Light Path for one or more Channels available for this Instrument. An Instrument may have several Mirrors of different types, such as Dichroic, Beamsplitter or Reflector. This element can be associated with an optional Optics Holder, such as a Filter Cube, Filter Turret, Filter Wheel, or Filter Slider.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.delete

Reimplemented by: com.inscoper.nbo.BeamSplitter.delete, com.inscoper.nbo.Dichroic_Type.delete, com.inscoper.nbo.GenericDichroic.delete, com.inscoper.nbo.ReflectingMirror.delete, com.inscoper.nbo.StandardDichroic.delete

function MirroringDevice_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.BeamSplitter.getTypeName, com.inscoper.nbo.Dichroic_Type.getTypeName, com.inscoper.nbo.GenericDichroic.getTypeName, com.inscoper.nbo.ReflectingMirror.getTypeName, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.getXMLName, com.inscoper.nbo.Dichroic_Type.getXMLName, com.inscoper.nbo.GenericDichroic.getXMLName, com.inscoper.nbo.ReflectingMirror.getXMLName, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.getNBOType, com.inscoper.nbo.Dichroic_Type.getNBOType, com.inscoper.nbo.GenericDichroic.getNBOType, com.inscoper.nbo.ReflectingMirror.getNBOType, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.getChildren, com.inscoper.nbo.Dichroic_Type.getChildren, com.inscoper.nbo.GenericDichroic.getChildren, com.inscoper.nbo.ReflectingMirror.getChildren, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.getSubElements, com.inscoper.nbo.Dichroic_Type.getSubElements, com.inscoper.nbo.GenericDichroic.getSubElements, com.inscoper.nbo.ReflectingMirror.getSubElements, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.fromJsonFile, com.inscoper.nbo.Dichroic_Type.fromJsonFile, com.inscoper.nbo.GenericDichroic.fromJsonFile, com.inscoper.nbo.ReflectingMirror.fromJsonFile, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.fromJsonFile, com.inscoper.nbo.Dichroic_Type.fromJsonFile, com.inscoper.nbo.GenericDichroic.fromJsonFile, com.inscoper.nbo.ReflectingMirror.fromJsonFile, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.fromJsonString, com.inscoper.nbo.Dichroic_Type.fromJsonString, com.inscoper.nbo.GenericDichroic.fromJsonString, com.inscoper.nbo.ReflectingMirror.fromJsonString, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.fromJsonString, com.inscoper.nbo.Dichroic_Type.fromJsonString, com.inscoper.nbo.GenericDichroic.fromJsonString, com.inscoper.nbo.ReflectingMirror.fromJsonString, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.fromXmlFile, com.inscoper.nbo.Dichroic_Type.fromXmlFile, com.inscoper.nbo.GenericDichroic.fromXmlFile, com.inscoper.nbo.ReflectingMirror.fromXmlFile, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.fromXmlFile, com.inscoper.nbo.Dichroic_Type.fromXmlFile, com.inscoper.nbo.GenericDichroic.fromXmlFile, com.inscoper.nbo.ReflectingMirror.fromXmlFile, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.fromXmlString, com.inscoper.nbo.Dichroic_Type.fromXmlString, com.inscoper.nbo.GenericDichroic.fromXmlString, com.inscoper.nbo.ReflectingMirror.fromXmlString, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.fromXmlString, com.inscoper.nbo.Dichroic_Type.fromXmlString, com.inscoper.nbo.GenericDichroic.fromXmlString, com.inscoper.nbo.ReflectingMirror.fromXmlString, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.toXmlFile, com.inscoper.nbo.Dichroic_Type.toXmlFile, com.inscoper.nbo.GenericDichroic.toXmlFile, com.inscoper.nbo.ReflectingMirror.toXmlFile, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.toXmlFile, com.inscoper.nbo.Dichroic_Type.toXmlFile, com.inscoper.nbo.GenericDichroic.toXmlFile, com.inscoper.nbo.ReflectingMirror.toXmlFile, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.toXmlString, com.inscoper.nbo.Dichroic_Type.toXmlString, com.inscoper.nbo.GenericDichroic.toXmlString, com.inscoper.nbo.ReflectingMirror.toXmlString, com.inscoper.nbo.StandardDichroic.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.BeamSplitter.toXmlString, com.inscoper.nbo.Dichroic_Type.toXmlString, com.inscoper.nbo.GenericDichroic.toXmlString, com.inscoper.nbo.ReflectingMirror.toXmlString, com.inscoper.nbo.StandardDichroic.toXmlString

function setID¶

public void setID(
    MirrorID_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¶

function getID¶

function resetID¶

function hasID¶

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¶

function getName¶

function resetName¶

function hasName¶

function setOpticsHolderPosition¶

public void setOpticsHolderPosition(
    String value,
    boolean validate
)

Sets the value of the OpticsHolderPosition attribute.

Parameters:

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

This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.

function setOpticsHolderPosition¶

public void setOpticsHolderPosition(
    String value
)

Sets the value of the OpticsHolderPosition attribute.

Parameters:

value The value to set

This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.

function getOpticsHolderPosition¶

public String getOpticsHolderPosition()

Returns the value of the OpticsHolderPosition attribute.

Return: The value of the attribute

This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.

function resetOpticsHolderPosition¶

public void resetOpticsHolderPosition()

Resets the OpticsHolderPosition attribute to an unset state.

This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.

function hasOpticsHolderPosition¶

public boolean hasOpticsHolderPosition()

Checks whether the OpticsHolderPosition attribute is present.

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

This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.

function setMirrorType¶

public void setMirrorType(
    MirrorType_Type value,
    boolean validate
)

Sets the value of the MirrorType attribute.

Parameters:

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

This field records the general category of this Mirror.

function setMirrorType¶

function getMirrorType¶

function resetMirrorType¶

function hasMirrorType¶

public boolean hasMirrorType()

Checks whether the optional MirrorType attribute is present.

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

This field records the general category of this Mirror.

function setGeometry¶

public void setGeometry(
    MirrorGeometry_Type value,
    boolean validate
)

Sets the value of the Geometry attribute.

Parameters:

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

This field records the geometrical shape of the surface(s) of this Mirror.

function setGeometry¶

public void setGeometry(
    MirrorGeometry_Type value
)

Sets the value of the Geometry attribute.

Parameters:

value The value to set

This field records the geometrical shape of the surface(s) of this Mirror.

function getGeometry¶

public MirrorGeometry_Type getGeometry()

Returns the value of the Geometry attribute.

Return: The value of the attribute

This field records the geometrical shape of the surface(s) of this Mirror.

function resetGeometry¶

function hasGeometry¶

public boolean hasGeometry()

Checks whether the optional Geometry attribute is present.

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

This field records the geometrical shape of the surface(s) of this Mirror.

function setDiameter¶

public void setDiameter(
    float value,
    boolean validate
)

Sets the value of the Diameter attribute.

Parameters:

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

This field describes the Diameter of this optical element.

function setDiameter¶

function getDiameter¶

function resetDiameter¶

function hasDiameter¶

public boolean hasDiameter()

Checks whether the Diameter attribute is present.

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

This field describes the Diameter of this optical element.

function setDiameterUnit¶

public void setDiameterUnit(
    UnitsLength_Type value,
    boolean validate
)

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

function getDiameterUnit¶

function resetDiameterUnit¶

function hasDiameterUnit¶

public boolean hasDiameterUnit()

Checks whether the optional DiameterUnit attribute is present.

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

No description available in the XSD standard.

function setRadiusOfCurvature¶

public void setRadiusOfCurvature(
    float value,
    boolean validate
)

Sets the value of the RadiusOfCurvature attribute.

Parameters:

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

The radius of curvature of this Mirror. A spherical lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the radius of curvature of the surface.

function setRadiusOfCurvature¶

public void setRadiusOfCurvature(
    float value
)

Sets the value of the RadiusOfCurvature attribute.

Parameters:

value The value to set

The radius of curvature of this Mirror. A spherical lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the radius of curvature of the surface.

function getRadiusOfCurvature¶

public float getRadiusOfCurvature()

Returns the value of the RadiusOfCurvature attribute.

Return: The value of the attribute

The radius of curvature of this Mirror. A spherical lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the radius of curvature of the surface.

function resetRadiusOfCurvature¶

public void resetRadiusOfCurvature()

Resets the RadiusOfCurvature attribute to an unset state.

The radius of curvature of this Mirror. A spherical lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the radius of curvature of the surface.

function hasRadiusOfCurvature¶

public boolean hasRadiusOfCurvature()

Checks whether the RadiusOfCurvature attribute is present.

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

The radius of curvature of this Mirror. A spherical lens or Mirror surface has a center of curvature located either along or decentered from the system local optical axis. The vertex of the lens surface is located on the local optical axis. The distance from the vertex to the center of curvature is the radius of curvature of the surface.

function setRadiusOfCurvatureUnit¶

public void setRadiusOfCurvatureUnit(
    UnitsLength_Type value,
    boolean validate
)

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

public void setRadiusOfCurvatureUnit(
    UnitsLength_Type value
)

Sets the value of the RadiusOfCurvatureUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getRadiusOfCurvatureUnit¶

function resetRadiusOfCurvatureUnit¶

function hasRadiusOfCurvatureUnit¶

public boolean hasRadiusOfCurvatureUnit()

Checks whether the optional RadiusOfCurvatureUnit attribute is present.

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

No description available in the XSD standard.

function setAngleOfIncidence¶

public void setAngleOfIncidence(
    float value,
    boolean validate
)

Sets the value of the AngleOfIncidence attribute.

Parameters:

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

This field records the optimal angle of incidence (AOI) for this Mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the Mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function setAngleOfIncidence¶

public void setAngleOfIncidence(
    float value
)

Sets the value of the AngleOfIncidence attribute.

Parameters:

value The value to set

This field records the optimal angle of incidence (AOI) for this Mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the Mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function getAngleOfIncidence¶

public float getAngleOfIncidence()

Returns the value of the AngleOfIncidence attribute.

Return: The value of the attribute

This field records the optimal angle of incidence (AOI) for this Mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the Mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function resetAngleOfIncidence¶

public void resetAngleOfIncidence()

Resets the AngleOfIncidence attribute to an unset state.

This field records the optimal angle of incidence (AOI) for this Mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the Mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function hasAngleOfIncidence¶

public boolean hasAngleOfIncidence()

Checks whether the AngleOfIncidence attribute is present.

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

This field records the optimal angle of incidence (AOI) for this Mirror. The AOI is the angle between the optical axis of the incident light and the axis normal to the surface of the Mirror. In specular reflection AOI is by definition equal to the Angle Of Reflection (AOR).

function setAngleOfIncidenceUnit¶

public void setAngleOfIncidenceUnit(
    UnitsAngle_Type value,
    boolean validate
)

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

public void setAngleOfIncidenceUnit(
    UnitsAngle_Type value
)

Sets the value of the AngleOfIncidenceUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getAngleOfIncidenceUnit¶

function resetAngleOfIncidenceUnit¶

function hasAngleOfIncidenceUnit¶

public boolean hasAngleOfIncidenceUnit()

Checks whether the optional AngleOfIncidenceUnit attribute is present.

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

No description available in the XSD standard.

function setSubstrateType¶

public void setSubstrateType(
    String value,
    boolean validate
)

Sets the value of the SubstrateType attribute.

Parameters:

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

This field records the type of Substrate that is used for this Mirror. It is typically a ground and polished piece of optical glass.

function setSubstrateType¶

public void setSubstrateType(
    String value
)

Sets the value of the SubstrateType attribute.

Parameters:

value The value to set

This field records the type of Substrate that is used for this Mirror. It is typically a ground and polished piece of optical glass.

function getSubstrateType¶

public String getSubstrateType()

Returns the value of the SubstrateType attribute.

Return: The value of the attribute

This field records the type of Substrate that is used for this Mirror. It is typically a ground and polished piece of optical glass.

function resetSubstrateType¶

public void resetSubstrateType()

Resets the SubstrateType attribute to an unset state.

This field records the type of Substrate that is used for this Mirror. It is typically a ground and polished piece of optical glass.

function hasSubstrateType¶

public boolean hasSubstrateType()

Checks whether the SubstrateType attribute is present.

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

This field records the type of Substrate that is used for this Mirror. It is typically a ground and polished piece of optical glass.

function setSubstrateMaterial¶

public void setSubstrateMaterial(
    OpticalMaterialName_Type value,
    boolean validate
)

Sets the value of the SubstrateMaterial attribute.

Parameters:

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

This field records the chemical composition or the designation of the substrate of this Mirroring Device. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica or Borofloat.

function setSubstrateMaterial¶

public void setSubstrateMaterial(
    OpticalMaterialName_Type value
)

Sets the value of the SubstrateMaterial attribute.

Parameters:

value The value to set

This field records the chemical composition or the designation of the substrate of this Mirroring Device. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica or Borofloat.

function getSubstrateMaterial¶

public OpticalMaterialName_Type getSubstrateMaterial()

Returns the value of the SubstrateMaterial attribute.

Return: The value of the attribute

This field records the chemical composition or the designation of the substrate of this Mirroring Device. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica or Borofloat.

function resetSubstrateMaterial¶

public void resetSubstrateMaterial()

Resets the SubstrateMaterial attribute to an unset state.

This field records the chemical composition or the designation of the substrate of this Mirroring Device. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica or Borofloat.

function hasSubstrateMaterial¶

public boolean hasSubstrateMaterial()

Checks whether the optional SubstrateMaterial attribute is present.

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

This field records the chemical composition or the designation of the substrate of this Mirroring Device. The substrate is typically composed of a glass material with low autofluorescence, such as UV-grade fused silica or Borofloat.

function setGlassCode¶

public void setGlassCode(
    String value,
    boolean validate
)

Sets the value of the GlassCode attribute.

Parameters:

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

If available, this field records the international Glass Code of the material that constitutes this Mirror. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.

function setGlassCode¶

public void setGlassCode(
    String value
)

Sets the value of the GlassCode attribute.

Parameters:

value The value to set

If available, this field records the international Glass Code of the material that constitutes this Mirror. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.

function getGlassCode¶

public String getGlassCode()

Returns the value of the GlassCode attribute.

Return: The value of the attribute

If available, this field records the international Glass Code of the material that constitutes this Mirror. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.

function resetGlassCode¶

public void resetGlassCode()

Resets the GlassCode attribute to an unset state.

If available, this field records the international Glass Code of the material that constitutes this Mirror. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.

function hasGlassCode¶

public boolean hasGlassCode()

Checks whether the GlassCode attribute is present.

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

If available, this field records the international Glass Code of the material that constitutes this Mirror. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.

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¶

function getAnnotationRef¶

function resetAnnotationRef¶

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 MirroringDevice_Type __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.__internal_create

Reimplemented by: com.inscoper.nbo.BeamSplitter.__internal_create, com.inscoper.nbo.Dichroic_Type.__internal_create, com.inscoper.nbo.GenericDichroic.__internal_create, com.inscoper.nbo.ReflectingMirror.__internal_create, com.inscoper.nbo.StandardDichroic.__internal_create

function fromBase¶

public static MirroringDevice_Type fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a MirroringDevice_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.BeamSplitter.fromBase, com.inscoper.nbo.Dichroic_Type.fromBase, com.inscoper.nbo.GenericDichroic.fromBase, com.inscoper.nbo.ReflectingMirror.fromBase, com.inscoper.nbo.StandardDichroic.fromBase

function getOpticsHolderPositionAllowedValues¶

public static StringSet getOpticsHolderPositionAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

This field records the position of this Mirroring Device in a Optics Holder of any kind, such as a Slider, Turret or Wheel.

function getAngleOfIncidenceUnitAllowedValues¶

function getSubstrateTypeAllowedValues¶

public static StringSet getSubstrateTypeAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

This field records the type of Substrate that is used for this Mirror. It is typically a ground and polished piece of optical glass.

function getGlassCodeAllowedValues¶

public static StringSet getGlassCodeAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

If available, this field records the international Glass Code of the material that constitutes this Mirror. The Glass Code designation is based on U.S. military standard MIL-G-174, and it consists of a six-digit number specifying the glass according to its Refractive Index nd at the Fraunhofer d- (or D3-) line, and its Abbe Number Vd also taken at that line. The resulting Glass Code is the value of nd-1 rounded to three digits, followed by Vd rounded to three digits, with all decimal points ignored. For example, BK7 has nd = 1.5168 and Vd = 64.17, giving a six-digit Glass Code of 517642.

Protected Functions Documentation¶

function MirroringDevice_Type¶

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.swigSetCMemOwn

Reimplemented by: com.inscoper.nbo.BeamSplitter.swigSetCMemOwn, com.inscoper.nbo.Dichroic_Type.swigSetCMemOwn, com.inscoper.nbo.GenericDichroic.swigSetCMemOwn, com.inscoper.nbo.ReflectingMirror.swigSetCMemOwn, com.inscoper.nbo.StandardDichroic.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.finalize

Reimplemented by: com.inscoper.nbo.BeamSplitter.finalize, com.inscoper.nbo.Dichroic_Type.finalize, com.inscoper.nbo.GenericDichroic.finalize, com.inscoper.nbo.ReflectingMirror.finalize, com.inscoper.nbo.StandardDichroic.finalize