com.inscoper.nbo.Prism¶

Represents the XML element Prism. More...

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

Public Functions¶

	Name
synchronized void	delete()
	Prism()
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(PrismID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(PrismID_Type value) Sets the value of the ID attribute.
PrismID_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	setDIC(DICPrismType_Type value, boolean validate) Sets the value of the DIC attribute.
void	setDIC(DICPrismType_Type value) Sets the value of the DIC attribute.
DICPrismType_Type	getDIC() Returns the value of the DIC attribute.
void	resetDIC() Resets the DIC attribute to an unset state.
boolean	hasDIC() Checks whether the optional DIC attribute is present.
void	setFunction(PrismFunction_Type value, boolean validate) Sets the value of the Function attribute.
void	setFunction(PrismFunction_Type value) Sets the value of the Function attribute.
PrismFunction_Type	getFunction() Returns the value of the Function attribute.
void	resetFunction() Resets the Function attribute to an unset state.
boolean	hasFunction() Checks whether the optional Function attribute is present.
void	setCondenser(boolean value, boolean validate) Sets the value of the Condenser attribute.
void	setCondenser(boolean value) Sets the value of the Condenser attribute.
boolean	getCondenser() Returns the value of the Condenser attribute.
void	resetCondenser() Resets the Condenser attribute to an unset state.
boolean	hasCondenser() Checks whether the Condenser attribute is present.
void	setOilObjective(boolean value, boolean validate) Sets the value of the OilObjective attribute.
void	setOilObjective(boolean value) Sets the value of the OilObjective attribute.
boolean	getOilObjective() Returns the value of the OilObjective attribute.
void	resetOilObjective() Resets the OilObjective attribute to an unset state.
boolean	hasOilObjective() Checks whether the OilObjective attribute is present.
void	setCompound(boolean value, boolean validate) Sets the value of the Compound attribute.
void	setCompound(boolean value) Sets the value of the Compound attribute.
boolean	getCompound() Returns the value of the Compound attribute.
void	resetCompound() Resets the Compound attribute to an unset state.
boolean	hasCompound() Checks whether the Compound attribute is present.
void	setRefractiveIndex(float value, boolean validate) Sets the value of the RefractiveIndex attribute.
void	setRefractiveIndex(float value) Sets the value of the RefractiveIndex attribute.
float	getRefractiveIndex() Returns the value of the RefractiveIndex attribute.
void	resetRefractiveIndex() Resets the RefractiveIndex attribute to an unset state.
boolean	hasRefractiveIndex() Checks whether the RefractiveIndex attribute is present.
void	setReflectance(float value, boolean validate) Sets the value of the Reflectance attribute.
void	setReflectance(float value) Sets the value of the Reflectance attribute.
float	getReflectance() Returns the value of the Reflectance attribute.
void	resetReflectance() Resets the Reflectance attribute to an unset state.
boolean	hasReflectance() Checks whether the Reflectance 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	setDeviationAngle(float value, boolean validate) Sets the value of the DeviationAngle attribute.
void	setDeviationAngle(float value) Sets the value of the DeviationAngle attribute.
float	getDeviationAngle() Returns the value of the DeviationAngle attribute.
void	resetDeviationAngle() Resets the DeviationAngle attribute to an unset state.
boolean	hasDeviationAngle() Checks whether the DeviationAngle attribute is present.
void	setDevianceAngleUnit(UnitsAngle_Type value, boolean validate) Sets the value of the DevianceAngleUnit attribute.
void	setDevianceAngleUnit(UnitsAngle_Type value) Sets the value of the DevianceAngleUnit attribute.
UnitsAngle_Type	getDevianceAngleUnit() Returns the value of the DevianceAngleUnit attribute.
void	resetDevianceAngleUnit() Resets the DevianceAngleUnit attribute to an unset state.
boolean	hasDevianceAngleUnit() Checks whether the optional DevianceAngleUnit attribute is present.
void	setPrismAngle(float value, boolean validate) Sets the value of the PrismAngle attribute.
void	setPrismAngle(float value) Sets the value of the PrismAngle attribute.
float	getPrismAngle() Returns the value of the PrismAngle attribute.
void	resetPrismAngle() Resets the PrismAngle attribute to an unset state.
boolean	hasPrismAngle() Checks whether the PrismAngle attribute is present.
void	setPrismAngleUnit(UnitsAngle_Type value, boolean validate) Sets the value of the PrismAngleUnit attribute.
void	setPrismAngleUnit(UnitsAngle_Type value) Sets the value of the PrismAngleUnit attribute.
UnitsAngle_Type	getPrismAngleUnit() Returns the value of the PrismAngleUnit attribute.
void	resetPrismAngleUnit() Resets the PrismAngleUnit attribute to an unset state.
boolean	hasPrismAngleUnit() Checks whether the optional PrismAngleUnit attribute is present.
void	setDesign(PrismDesign_Type value, boolean validate) Sets the value of the Design attribute.
void	setDesign(PrismDesign_Type value) Sets the value of the Design attribute.
PrismDesign_Type	getDesign() Returns the value of the Design attribute.
void	resetDesign() Resets the Design attribute to an unset state.
boolean	hasDesign() Checks whether the optional Design attribute is present.
void	setAbbeNumber(float value, boolean validate) Sets the value of the AbbeNumber attribute.
void	setAbbeNumber(float value) Sets the value of the AbbeNumber attribute.
float	getAbbeNumber() Returns the value of the AbbeNumber attribute.
void	resetAbbeNumber() Resets the AbbeNumber attribute to an unset state.
boolean	hasAbbeNumber() Checks whether the AbbeNumber attribute is present.
void	setMaterialName(OpticalMaterialName_Type value, boolean validate) Sets the value of the MaterialName attribute.
void	setMaterialName(OpticalMaterialName_Type value) Sets the value of the MaterialName attribute.
OpticalMaterialName_Type	getMaterialName() Returns the value of the MaterialName attribute.
void	resetMaterialName() Resets the MaterialName attribute to an unset state.
boolean	hasMaterialName() Checks whether the optional MaterialName 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	setDensity(float value, boolean validate) Sets the value of the Density attribute.
void	setDensity(float value) Sets the value of the Density attribute.
float	getDensity() Returns the value of the Density attribute.
void	resetDensity() Resets the Density attribute to an unset state.
boolean	hasDensity() Checks whether the Density attribute is present.
void	setDensityUnit(UnitsDensity_Type value, boolean validate) Sets the value of the DensityUnit attribute.
void	setDensityUnit(UnitsDensity_Type value) Sets the value of the DensityUnit attribute.
UnitsDensity_Type	getDensityUnit() Returns the value of the DensityUnit attribute.
void	resetDensityUnit() Resets the DensityUnit attribute to an unset state.
boolean	hasDensityUnit() Checks whether the optional DensityUnit attribute is present.
void	setWavelengthRange_List(Prism_InlineWavelengthRangeVector value, boolean validate) Sets the list of WavelengthRange elements.
void	setWavelengthRange_List(Prism_InlineWavelengthRangeVector value) Sets the list of WavelengthRange elements.
Prism_InlineWavelengthRangeVector	getWavelengthRange_List() Returns the list of WavelengthRange elements.
void	addToWavelengthRange_List(Prism_InlineWavelengthRange value, boolean validate) Adds a new WavelengthRange element to this object.
void	addToWavelengthRange_List(Prism_InlineWavelengthRange value) Adds a new WavelengthRange element to this object.
void	clearWavelengthRange_List() Clear the list of WavelengthRange.
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.
Prism	__internal_create(long cPtr, boolean own)
Prism	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a Prism.
StringSet	getGlassCodeAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

	Name
	Prism(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(Prism 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.Prism;

Represents the XML element Prism.

This element describes a Prism positioned in the Light Path for one or more Channels available for this Instrument. A Prism is a block of glass or other transparent material with at least two intersecting flat, polished surfaces, used to disperse light or deviate it through an angle. A Prism can be viewed as an ensemble of different rigidly mounted Mirrors, with each face having a permanent orientation with respect to others. A Prism can be employed to deflect or deviate a light beam, rotate or invert an Image, separate polarization states, or disperse light into its component Wavelengths. An Instrument may have several Prisms with different functionality such as Polarizing, Reflecting, or Refracting (or Dispersing). Polarizing Prisms are birefringent crystals that divide incident non-polarized light into separate components polarized orthogonally to each other. Reflecting Prisms are useful for redirecting light beams by total internal reflection. Refracting (or Dispersing) Prisms can be employed to bend and separate light into its component colors. This element can be associated with an optional Optics Turret.

Public Functions Documentation¶

function delete¶

function Prism¶

function getTypeName¶

function getXMLName¶

function 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

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

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

function 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

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

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

function 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

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

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

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

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

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

function setID¶

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

public void setDIC(
    DICPrismType_Type value,
    boolean validate
)

Sets the value of the DIC attribute.

Parameters:

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

This field records whether this Prism is used for Differential Interference Contrast (DIC) microscopy and, if so, what DIC-compatible type it is (i.e., deSenarmont, Nomarski or Wollaston).

function setDIC¶

public void setDIC(
    DICPrismType_Type value
)

Sets the value of the DIC attribute.

Parameters:

value The value to set

This field records whether this Prism is used for Differential Interference Contrast (DIC) microscopy and, if so, what DIC-compatible type it is (i.e., deSenarmont, Nomarski or Wollaston).

function getDIC¶

public DICPrismType_Type getDIC()

Returns the value of the DIC attribute.

Return: The value of the attribute

This field records whether this Prism is used for Differential Interference Contrast (DIC) microscopy and, if so, what DIC-compatible type it is (i.e., deSenarmont, Nomarski or Wollaston).

function resetDIC¶

public void resetDIC()

Resets the DIC attribute to an unset state.

This field records whether this Prism is used for Differential Interference Contrast (DIC) microscopy and, if so, what DIC-compatible type it is (i.e., deSenarmont, Nomarski or Wollaston).

function hasDIC¶

public boolean hasDIC()

Checks whether the optional DIC attribute is present.

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

This field records whether this Prism is used for Differential Interference Contrast (DIC) microscopy and, if so, what DIC-compatible type it is (i.e., deSenarmont, Nomarski or Wollaston).

function setFunction¶

public void setFunction(
    PrismFunction_Type value,
    boolean validate
)

Sets the value of the Function attribute.

Parameters:

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

This field records the function of this Prism. Beam-shaping (i.e., Anamorphic) Prism pairs are used for reshaping the profile of a laser beam. For example, the elliptical beam from a laser diode can be transformed into a beam with circular cross-section, by magnifying the elliptical beam in one dimension. They can also be used to convert a circular beam into an elliptical beam. Dispersing prisms can be employed to bend and separate light into its component wavelengths. Polarizing prisms (i.e., Glan–Thompson, Nomarski, Wollaston) are birefringent crystals, which divide incident non-polarized light into separate components polarized orthogonally to each other. Reflecting prisms are useful for redirecting (i.e., flip, invert, rotate, etc.) light beams by total internal reflection or for dividing them into two or more separate beams (i.e., beam-splitting) one.

function setFunction¶

public void setFunction(
    PrismFunction_Type value
)

Sets the value of the Function attribute.

Parameters:

value The value to set

This field records the function of this Prism. Beam-shaping (i.e., Anamorphic) Prism pairs are used for reshaping the profile of a laser beam. For example, the elliptical beam from a laser diode can be transformed into a beam with circular cross-section, by magnifying the elliptical beam in one dimension. They can also be used to convert a circular beam into an elliptical beam. Dispersing prisms can be employed to bend and separate light into its component wavelengths. Polarizing prisms (i.e., Glan–Thompson, Nomarski, Wollaston) are birefringent crystals, which divide incident non-polarized light into separate components polarized orthogonally to each other. Reflecting prisms are useful for redirecting (i.e., flip, invert, rotate, etc.) light beams by total internal reflection or for dividing them into two or more separate beams (i.e., beam-splitting) one.

function getFunction¶

public PrismFunction_Type getFunction()

Returns the value of the Function attribute.

Return: The value of the attribute

This field records the function of this Prism. Beam-shaping (i.e., Anamorphic) Prism pairs are used for reshaping the profile of a laser beam. For example, the elliptical beam from a laser diode can be transformed into a beam with circular cross-section, by magnifying the elliptical beam in one dimension. They can also be used to convert a circular beam into an elliptical beam. Dispersing prisms can be employed to bend and separate light into its component wavelengths. Polarizing prisms (i.e., Glan–Thompson, Nomarski, Wollaston) are birefringent crystals, which divide incident non-polarized light into separate components polarized orthogonally to each other. Reflecting prisms are useful for redirecting (i.e., flip, invert, rotate, etc.) light beams by total internal reflection or for dividing them into two or more separate beams (i.e., beam-splitting) one.

function resetFunction¶

public void resetFunction()

Resets the Function attribute to an unset state.

This field records the function of this Prism. Beam-shaping (i.e., Anamorphic) Prism pairs are used for reshaping the profile of a laser beam. For example, the elliptical beam from a laser diode can be transformed into a beam with circular cross-section, by magnifying the elliptical beam in one dimension. They can also be used to convert a circular beam into an elliptical beam. Dispersing prisms can be employed to bend and separate light into its component wavelengths. Polarizing prisms (i.e., Glan–Thompson, Nomarski, Wollaston) are birefringent crystals, which divide incident non-polarized light into separate components polarized orthogonally to each other. Reflecting prisms are useful for redirecting (i.e., flip, invert, rotate, etc.) light beams by total internal reflection or for dividing them into two or more separate beams (i.e., beam-splitting) one.

function hasFunction¶

public boolean hasFunction()

Checks whether the optional Function attribute is present.

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

This field records the function of this Prism. Beam-shaping (i.e., Anamorphic) Prism pairs are used for reshaping the profile of a laser beam. For example, the elliptical beam from a laser diode can be transformed into a beam with circular cross-section, by magnifying the elliptical beam in one dimension. They can also be used to convert a circular beam into an elliptical beam. Dispersing prisms can be employed to bend and separate light into its component wavelengths. Polarizing prisms (i.e., Glan–Thompson, Nomarski, Wollaston) are birefringent crystals, which divide incident non-polarized light into separate components polarized orthogonally to each other. Reflecting prisms are useful for redirecting (i.e., flip, invert, rotate, etc.) light beams by total internal reflection or for dividing them into two or more separate beams (i.e., beam-splitting) one.

function setCondenser¶

public void setCondenser(
    boolean value,
    boolean validate
)

Sets the value of the Condenser attribute.

Parameters:

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

This field records whether this Prism is within the Condenser (True) or the Objective (False).

function setCondenser¶

public void setCondenser(
    boolean value
)

Sets the value of the Condenser attribute.

Parameters:

value The value to set

This field records whether this Prism is within the Condenser (True) or the Objective (False).

function getCondenser¶

public boolean getCondenser()

Returns the value of the Condenser attribute.

Return: The value of the attribute

This field records whether this Prism is within the Condenser (True) or the Objective (False).

function resetCondenser¶

function hasCondenser¶

public boolean hasCondenser()

Checks whether the Condenser attribute is present.

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

This field records whether this Prism is within the Condenser (True) or the Objective (False).

function setOilObjective¶

public void setOilObjective(
    boolean value,
    boolean validate
)

Sets the value of the OilObjective attribute.

Parameters:

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

This field records whether this Prism is designed to work with oil Objectives (True) or not (False).

function setOilObjective¶

public void setOilObjective(
    boolean value
)

Sets the value of the OilObjective attribute.

Parameters:

value The value to set

This field records whether this Prism is designed to work with oil Objectives (True) or not (False).

function getOilObjective¶

public boolean getOilObjective()

Returns the value of the OilObjective attribute.

Return: The value of the attribute

This field records whether this Prism is designed to work with oil Objectives (True) or not (False).

function resetOilObjective¶

function hasOilObjective¶

public boolean hasOilObjective()

Checks whether the OilObjective attribute is present.

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

This field records whether this Prism is designed to work with oil Objectives (True) or not (False).

function setCompound¶

public void setCompound(
    boolean value,
    boolean validate
)

Sets the value of the Compound attribute.

Parameters:

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

This field records whether this Prism is a Compound Prism (i.e., a set of multiple triangular prism elements placed in contact, and often cemented together to form a solid assembly; True) or a Simple Prism (False).

function setCompound¶

public void setCompound(
    boolean value
)

Sets the value of the Compound attribute.

Parameters:

value The value to set

This field records whether this Prism is a Compound Prism (i.e., a set of multiple triangular prism elements placed in contact, and often cemented together to form a solid assembly; True) or a Simple Prism (False).

function getCompound¶

public boolean getCompound()

Returns the value of the Compound attribute.

Return: The value of the attribute

This field records whether this Prism is a Compound Prism (i.e., a set of multiple triangular prism elements placed in contact, and often cemented together to form a solid assembly; True) or a Simple Prism (False).

function resetCompound¶

public void resetCompound()

Resets the Compound attribute to an unset state.

This field records whether this Prism is a Compound Prism (i.e., a set of multiple triangular prism elements placed in contact, and often cemented together to form a solid assembly; True) or a Simple Prism (False).

function hasCompound¶

public boolean hasCompound()

Checks whether the Compound attribute is present.

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

This field records whether this Prism is a Compound Prism (i.e., a set of multiple triangular prism elements placed in contact, and often cemented together to form a solid assembly; True) or a Simple Prism (False).

function setRefractiveIndex¶

public void setRefractiveIndex(
    float value,
    boolean validate
)

Sets the value of the RefractiveIndex attribute.

Parameters:

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

This field records the Refractive Index of the material this Prism is made of, as specified by the Manufacturer.

function setRefractiveIndex¶

public void setRefractiveIndex(
    float value
)

Sets the value of the RefractiveIndex attribute.

Parameters:

value The value to set

This field records the Refractive Index of the material this Prism is made of, as specified by the Manufacturer.

function getRefractiveIndex¶

public float getRefractiveIndex()

Returns the value of the RefractiveIndex attribute.

Return: The value of the attribute

This field records the Refractive Index of the material this Prism is made of, as specified by the Manufacturer.

function resetRefractiveIndex¶

public void resetRefractiveIndex()

Resets the RefractiveIndex attribute to an unset state.

This field records the Refractive Index of the material this Prism is made of, as specified by the Manufacturer.

function hasRefractiveIndex¶

public boolean hasRefractiveIndex()

Checks whether the RefractiveIndex attribute is present.

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

This field records the Refractive Index of the material this Prism is made of, as specified by the Manufacturer.

function setReflectance¶

public void setReflectance(
    float value,
    boolean validate
)

Sets the value of the Reflectance attribute.

Parameters:

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

This field records the maximum amount of light this Prism is capable of transmitting at peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function setReflectance¶

public void setReflectance(
    float value
)

Sets the value of the Reflectance attribute.

Parameters:

value The value to set

This field records the maximum amount of light this Prism is capable of transmitting at peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function getReflectance¶

public float getReflectance()

Returns the value of the Reflectance attribute.

Return: The value of the attribute

This field records the maximum amount of light this Prism is capable of transmitting at peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function resetReflectance¶

public void resetReflectance()

Resets the Reflectance attribute to an unset state.

This field records the maximum amount of light this Prism is capable of transmitting at peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

function hasReflectance¶

public boolean hasReflectance()

Checks whether the Reflectance attribute is present.

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

This field records the maximum amount of light this Prism is capable of transmitting at peak Wavelength. It is represented as a fractional value from 0.0 to 1.0.

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 Angle Of Incidence (AOI) is the angle between a beam of light incident on the Prism surface and the line perpendicular to the surface at the point of incidence, called the normal.

function setAngleOfIncidence¶

public void setAngleOfIncidence(
    float value
)

Sets the value of the AngleOfIncidence attribute.

Parameters:

value The value to set

This field records the Angle Of Incidence (AOI) is the angle between a beam of light incident on the Prism surface and the line perpendicular to the surface at the point of incidence, called the normal.

function getAngleOfIncidence¶

public float getAngleOfIncidence()

Returns the value of the AngleOfIncidence attribute.

Return: The value of the attribute

This field records the Angle Of Incidence (AOI) is the angle between a beam of light incident on the Prism surface and the line perpendicular to the surface at the point of incidence, called the normal.

function resetAngleOfIncidence¶

public void resetAngleOfIncidence()

Resets the AngleOfIncidence attribute to an unset state.

This field records the Angle Of Incidence (AOI) is the angle between a beam of light incident on the Prism surface and the line perpendicular to the surface at the point of incidence, called the normal.

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 Angle Of Incidence (AOI) is the angle between a beam of light incident on the Prism surface and the line perpendicular to the surface at the point of incidence, called the normal.

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

public void setDeviationAngle(
    float value,
    boolean validate
)

Sets the value of the DeviationAngle attribute.

Parameters:

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

This field records the Deviation Angle of this Prism. A beam passing through an object like a prism is deflected twice: once entering, and again when exiting. The sum of these two deflections is called the deviation angle and is measured with respect to the incident ray.

function setDeviationAngle¶

public void setDeviationAngle(
    float value
)

Sets the value of the DeviationAngle attribute.

Parameters:

value The value to set

This field records the Deviation Angle of this Prism. A beam passing through an object like a prism is deflected twice: once entering, and again when exiting. The sum of these two deflections is called the deviation angle and is measured with respect to the incident ray.

function getDeviationAngle¶

public float getDeviationAngle()

Returns the value of the DeviationAngle attribute.

Return: The value of the attribute

This field records the Deviation Angle of this Prism. A beam passing through an object like a prism is deflected twice: once entering, and again when exiting. The sum of these two deflections is called the deviation angle and is measured with respect to the incident ray.

function resetDeviationAngle¶

public void resetDeviationAngle()

Resets the DeviationAngle attribute to an unset state.

This field records the Deviation Angle of this Prism. A beam passing through an object like a prism is deflected twice: once entering, and again when exiting. The sum of these two deflections is called the deviation angle and is measured with respect to the incident ray.

function hasDeviationAngle¶

public boolean hasDeviationAngle()

Checks whether the DeviationAngle attribute is present.

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

This field records the Deviation Angle of this Prism. A beam passing through an object like a prism is deflected twice: once entering, and again when exiting. The sum of these two deflections is called the deviation angle and is measured with respect to the incident ray.

function setDevianceAngleUnit¶

public void setDevianceAngleUnit(
    UnitsAngle_Type value,
    boolean validate
)

Sets the value of the DevianceAngleUnit 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 setDevianceAngleUnit¶

public void setDevianceAngleUnit(
    UnitsAngle_Type value
)

Sets the value of the DevianceAngleUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getDevianceAngleUnit¶

function resetDevianceAngleUnit¶

function hasDevianceAngleUnit¶

public boolean hasDevianceAngleUnit()

Checks whether the optional DevianceAngleUnit attribute is present.

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

No description available in the XSD standard.

function setPrismAngle¶

public void setPrismAngle(
    float value,
    boolean validate
)

Sets the value of the PrismAngle attribute.

Parameters:

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

This field records the Angle between two surfaces of this Prism.

function setPrismAngle¶

function getPrismAngle¶

function resetPrismAngle¶

function hasPrismAngle¶

public boolean hasPrismAngle()

Checks whether the PrismAngle attribute is present.

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

This field records the Angle between two surfaces of this Prism.

function setPrismAngleUnit¶

public void setPrismAngleUnit(
    UnitsAngle_Type value,
    boolean validate
)

Sets the value of the PrismAngleUnit 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 setPrismAngleUnit¶

function getPrismAngleUnit¶

function resetPrismAngleUnit¶

function hasPrismAngleUnit¶

public boolean hasPrismAngleUnit()

Checks whether the optional PrismAngleUnit attribute is present.

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

No description available in the XSD standard.

function setDesign¶

public void setDesign(
    PrismDesign_Type value,
    boolean validate
)

Sets the value of the Design attribute.

Parameters:

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

This field records the shape of the Prism with specific reference to the angles defined by its faces.

function setDesign¶

public void setDesign(
    PrismDesign_Type value
)

Sets the value of the Design attribute.

Parameters:

value The value to set

This field records the shape of the Prism with specific reference to the angles defined by its faces.

function getDesign¶

public PrismDesign_Type getDesign()

Returns the value of the Design attribute.

Return: The value of the attribute

This field records the shape of the Prism with specific reference to the angles defined by its faces.

function resetDesign¶

function hasDesign¶

public boolean hasDesign()

Checks whether the optional Design attribute is present.

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

This field records the shape of the Prism with specific reference to the angles defined by its faces.

function setAbbeNumber¶

public void setAbbeNumber(
    float value,
    boolean validate
)

Sets the value of the AbbeNumber attribute.

Parameters:

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

This field records the Abbe number of this Prism. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.

function setAbbeNumber¶

public void setAbbeNumber(
    float value
)

Sets the value of the AbbeNumber attribute.

Parameters:

value The value to set

This field records the Abbe number of this Prism. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.

function getAbbeNumber¶

public float getAbbeNumber()

Returns the value of the AbbeNumber attribute.

Return: The value of the attribute

This field records the Abbe number of this Prism. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.

function resetAbbeNumber¶

public void resetAbbeNumber()

Resets the AbbeNumber attribute to an unset state.

This field records the Abbe number of this Prism. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.

function hasAbbeNumber¶

public boolean hasAbbeNumber()

Checks whether the AbbeNumber attribute is present.

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

This field records the Abbe number of this Prism. The Abbe Number is a measure of the material's dispersion (variation of Refractive Index versus Wavelength), with high values indicating low dispersion.

function setMaterialName¶

public void setMaterialName(
    OpticalMaterialName_Type value,
    boolean validate
)

Sets the value of the MaterialName attribute.

Parameters:

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

This field records the chemical composition or designation of the Material this Prism is made of.

function setMaterialName¶

public void setMaterialName(
    OpticalMaterialName_Type value
)

Sets the value of the MaterialName attribute.

Parameters:

value The value to set

This field records the chemical composition or designation of the Material this Prism is made of.

function getMaterialName¶

public OpticalMaterialName_Type getMaterialName()

Returns the value of the MaterialName attribute.

Return: The value of the attribute

This field records the chemical composition or designation of the Material this Prism is made of.

function resetMaterialName¶

function hasMaterialName¶

public boolean hasMaterialName()

Checks whether the optional MaterialName attribute is present.

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

This field records the chemical composition or designation of the Material this Prism is made of.

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 Prism. 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 Prism. 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 Prism. 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 Prism. 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 Prism. 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 setDensity¶

public void setDensity(
    float value,
    boolean validate
)

Sets the value of the Density attribute.

Parameters:

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

This field records the Density of the material this Prism is made of.

function setDensity¶

function getDensity¶

function resetDensity¶

function hasDensity¶

public boolean hasDensity()

Checks whether the Density attribute is present.

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

This field records the Density of the material this Prism is made of.

function setDensityUnit¶

public void setDensityUnit(
    UnitsDensity_Type value,
    boolean validate
)

Sets the value of the DensityUnit 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 setDensityUnit¶

function getDensityUnit¶

function resetDensityUnit¶

function hasDensityUnit¶

public boolean hasDensityUnit()

Checks whether the optional DensityUnit attribute is present.

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

No description available in the XSD standard.

function setWavelengthRange_List¶

public void setWavelengthRange_List(
    Prism_InlineWavelengthRangeVector value,
    boolean validate
)

Sets the list of WavelengthRange elements.

Parameters:

value The new list of WavelengthRange elements
validate If true, validates constraints on value. Default is true.

This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.

function setWavelengthRange_List¶

public void setWavelengthRange_List(
    Prism_InlineWavelengthRangeVector value
)

Sets the list of WavelengthRange elements.

Parameters:

value The new list of WavelengthRange elements

This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.

function getWavelengthRange_List¶

public Prism_InlineWavelengthRangeVector getWavelengthRange_List()

Returns the list of WavelengthRange elements.

Return: The list of WavelengthRange elements

This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.

function addToWavelengthRange_List¶

public void addToWavelengthRange_List(
    Prism_InlineWavelengthRange value,
    boolean validate
)

Adds a new WavelengthRange element to this object.

Parameters:

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

This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.

function addToWavelengthRange_List¶

public void addToWavelengthRange_List(
    Prism_InlineWavelengthRange value
)

Adds a new WavelengthRange element to this object.

Parameters:

value The element to add

This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.

function clearWavelengthRange_List¶

public void clearWavelengthRange_List()

Clear the list of WavelengthRange.

This element records the Range of Wavelengths this device is designed for, according to the Manufacturer. Multiple of this element may be used.

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¶

function fromBase¶

public static Prism fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a Prism.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromBase

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 Prism. 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.