com.inscoper.nbo.PolarizationOptics

Represents the XML element PolarizationOptics. More...

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

Public Functions

	Name
synchronized void	delete()
	PolarizationOptics()
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) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setID(PolarizationOpticsID_Type value) Sets the value of the ID attribute.
PolarizationOpticsID_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) 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	setFunction(PolarizationOpticsFunction_Type value) Sets the value of the Function attribute.
PolarizationOpticsFunction_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	setCrossPolarizer(boolean value) Sets the value of the CrossPolarizer attribute.
boolean	getCrossPolarizer() Returns the value of the CrossPolarizer attribute.
void	setDIC(boolean value) Sets the value of the DIC attribute.
boolean	getDIC() Returns the value of the DIC attribute.
void	setBeamSplitter(boolean value) Sets the value of the BeamSplitter attribute.
boolean	getBeamSplitter() Returns the value of the BeamSplitter attribute.
void	resetBeamSplitter() Resets the BeamSplitter attribute to an unset state.
boolean	hasBeamSplitter() Checks whether the optional BeamSplitter attribute is present.
void	setFaradayIsolator(boolean value) Sets the value of the FaradayIsolator attribute.
boolean	getFaradayIsolator() Returns the value of the FaradayIsolator attribute.
void	resetFaradayIsolator() Resets the FaradayIsolator attribute to an unset state.
boolean	hasFaradayIsolator() Checks whether the optional FaradayIsolator attribute is present.
void	setConstruction(PolarizationOpticsConstruction_Type value) Sets the value of the Construction attribute.
PolarizationOpticsConstruction_Type	getConstruction() Returns the value of the Construction attribute.
void	resetConstruction() Resets the Construction attribute to an unset state.
boolean	hasConstruction() Checks whether the optional Construction attribute is present.
void	setRetardation(PolarizationOpticsRetardation_Type value) Sets the value of the Retardation attribute.
PolarizationOpticsRetardation_Type	getRetardation() Returns the value of the Retardation attribute.
void	resetRetardation() Resets the Retardation attribute to an unset state.
boolean	hasRetardation() Checks whether the optional Retardation attribute is present.
void	setFabrication(PolarizationOpticsFabrication_Type value) Sets the value of the Fabrication attribute.
PolarizationOpticsFabrication_Type	getFabrication() Returns the value of the Fabrication attribute.
void	resetFabrication() Resets the Fabrication attribute to an unset state.
boolean	hasFabrication() Checks whether the optional Fabrication attribute is present.
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) 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 optional GlassCode attribute is present.
void	setWavelengthRange_List(PolarizationOptics_InlineWavelengthRangeVector value) Sets the list of WavelengthRange elements.
PolarizationOptics_InlineWavelengthRangeVector	getWavelengthRange_List() Returns the list of WavelengthRange elements.
void	addToWavelengthRange_List(PolarizationOptics_InlineWavelengthRange value) Adds a new WavelengthRange element to this object.
void	clearWavelengthRange_List() Clear the list of WavelengthRange.
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.
PolarizationOptics	__internal_create(long cPtr, boolean own)

Protected Functions

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

Additional inherited members

Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
void	setManufacturer(String value) Sets the value of the Manufacturer attribute.
String	getManufacturer() Returns the value of the Manufacturer attribute.
void	setModel(String value) Sets the value of the Model attribute.
String	getModel() Returns the value of the Model attribute.
void	setCatalogNumber(String value) Sets the value of the CatalogNumber attribute.
String	getCatalogNumber() Returns the value of the CatalogNumber 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 optional LotNumber attribute is present.
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) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
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) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.

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.PolarizationOptics;

Represents the XML element PolarizationOptics.

This element describes a Polarization device positioned in the Ligth Path for this Instrument. A Polarization device is an optical filter rotatable through 360° that lets light waves of a specific polarization pass through while blocking light waves of other polarizations. This element can be associated with an optional Optics Turret.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.delete

function PolarizationOptics

public PolarizationOptics()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.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

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

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
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromJsonFile

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
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromXmlFile

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
)

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()

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(
    PolarizationOpticsID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

A Unique Identifier for this component.

function getID

public PolarizationOpticsID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

A Unique Identifier for this component.

function resetID

public void resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

function hasID

public boolean hasID()

Checks whether the optional ID attribute is present.

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

A Unique Identifier for this component.

function setName

public void setName(
    Denomination_Type value
)

Sets the value of the Name attribute.

Parameters:

value The value to set

A User-defined Name for this component.

function getName

public Denomination_Type getName()

Returns the value of the Name attribute.

Return: The value of the attribute

A User-defined Name for this component.

function resetName

public void resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

function hasName

public boolean hasName()

Checks whether the optional Name attribute is present.

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

A User-defined Name for this component.

function setFunction

public void setFunction(
    PolarizationOpticsFunction_Type value
)

Sets the value of the Function attribute.

Parameters:

value The value to set

This field records whether this Polarization Optics is used to generate (Polarizer) or to analyze (Analyzer) polarized light.

function getFunction

public PolarizationOpticsFunction_Type getFunction()

Returns the value of the Function attribute.

Return: The value of the attribute

This field records whether this Polarization Optics is used to generate (Polarizer) or to analyze (Analyzer) polarized light.

function resetFunction

public void resetFunction()

Resets the Function attribute to an unset state.

This field records whether this Polarization Optics is used to generate (Polarizer) or to analyze (Analyzer) polarized light.

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 whether this Polarization Optics is used to generate (Polarizer) or to analyze (Analyzer) polarized light.

function setCrossPolarizer

public void setCrossPolarizer(
    boolean value
)

Sets the value of the CrossPolarizer attribute.

Parameters:

value The value to set

This field records whether (True) or not (False) this Polarization Optics is a combination of an Analyzer and a Polarizer positioned orthogonal to each other.

function getCrossPolarizer

public boolean getCrossPolarizer()

Returns the value of the CrossPolarizer attribute.

Return: The value of the attribute

This field records whether (True) or not (False) this Polarization Optics is a combination of an Analyzer and a Polarizer positioned orthogonal to each other.

function setDIC

public void setDIC(
    boolean value
)

Sets the value of the DIC attribute.

Parameters:

value The value to set

This field records whether (True) or not (False) this PolarizationOptics is used for Differential Interference Contrast (DIC) microscopy.

function getDIC

public boolean getDIC()

Returns the value of the DIC attribute.

Return: The value of the attribute

This field records whether (True) or not (False) this PolarizationOptics is used for Differential Interference Contrast (DIC) microscopy.

function setBeamSplitter

public void setBeamSplitter(
    boolean value
)

Sets the value of the BeamSplitter attribute.

Parameters:

value The value to set

This field records whether (True) or not (False) this is PolarizationOptics has a beam splitter function.

function getBeamSplitter

public boolean getBeamSplitter()

Returns the value of the BeamSplitter attribute.

Return: The value of the attribute

This field records whether (True) or not (False) this is PolarizationOptics has a beam splitter function.

function resetBeamSplitter

public void resetBeamSplitter()

Resets the BeamSplitter attribute to an unset state.

This field records whether (True) or not (False) this is PolarizationOptics has a beam splitter function.

function hasBeamSplitter

public boolean hasBeamSplitter()

Checks whether the optional BeamSplitter attribute is present.

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

This field records whether (True) or not (False) this is PolarizationOptics has a beam splitter function.

function setFaradayIsolator

public void setFaradayIsolator(
    boolean value
)

Sets the value of the FaradayIsolator attribute.

Parameters:

value The value to set

This field records whether (True) or not (False) this PolarizationOptics is a Fraday Isolator. A Faraday Isolator is an optical component which allows light to pass through in only ONE direction and therefore protects laser systems against back reflection. It uses the Faraday magneto-optical effect to turn the polarization of light between various polarizers.

function getFaradayIsolator

public boolean getFaradayIsolator()

Returns the value of the FaradayIsolator attribute.

Return: The value of the attribute

This field records whether (True) or not (False) this PolarizationOptics is a Fraday Isolator. A Faraday Isolator is an optical component which allows light to pass through in only ONE direction and therefore protects laser systems against back reflection. It uses the Faraday magneto-optical effect to turn the polarization of light between various polarizers.

function resetFaradayIsolator

public void resetFaradayIsolator()

Resets the FaradayIsolator attribute to an unset state.

This field records whether (True) or not (False) this PolarizationOptics is a Fraday Isolator. A Faraday Isolator is an optical component which allows light to pass through in only ONE direction and therefore protects laser systems against back reflection. It uses the Faraday magneto-optical effect to turn the polarization of light between various polarizers.

function hasFaradayIsolator

public boolean hasFaradayIsolator()

Checks whether the optional FaradayIsolator attribute is present.

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

This field records whether (True) or not (False) this PolarizationOptics is a Fraday Isolator. A Faraday Isolator is an optical component which allows light to pass through in only ONE direction and therefore protects laser systems against back reflection. It uses the Faraday magneto-optical effect to turn the polarization of light between various polarizers.

function setConstruction

public void setConstruction(
    PolarizationOpticsConstruction_Type value
)

Sets the value of the Construction attribute.

Parameters:

value The value to set

This field records the modality with which this PolarizationOptics is constructed.

function getConstruction

public PolarizationOpticsConstruction_Type getConstruction()

Returns the value of the Construction attribute.

Return: The value of the attribute

This field records the modality with which this PolarizationOptics is constructed.

function resetConstruction

public void resetConstruction()

Resets the Construction attribute to an unset state.

This field records the modality with which this PolarizationOptics is constructed.

function hasConstruction

public boolean hasConstruction()

Checks whether the optional Construction attribute is present.

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

This field records the modality with which this PolarizationOptics is constructed.

function setRetardation

public void setRetardation(
    PolarizationOpticsRetardation_Type value
)

Sets the value of the Retardation attribute.

Parameters:

value The value to set

This field records the Phase shift that exists between the polarized light component projected along the fast axis and the part projected along the slow axis.

function getRetardation

public PolarizationOpticsRetardation_Type getRetardation()

Returns the value of the Retardation attribute.

Return: The value of the attribute

This field records the Phase shift that exists between the polarized light component projected along the fast axis and the part projected along the slow axis.

function resetRetardation

public void resetRetardation()

Resets the Retardation attribute to an unset state.

This field records the Phase shift that exists between the polarized light component projected along the fast axis and the part projected along the slow axis.

function hasRetardation

public boolean hasRetardation()

Checks whether the optional Retardation attribute is present.

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

This field records the Phase shift that exists between the polarized light component projected along the fast axis and the part projected along the slow axis.

function setFabrication

public void setFabrication(
    PolarizationOpticsFabrication_Type value
)

Sets the value of the Fabrication attribute.

Parameters:

value The value to set

This field records the way in with which this PolarizationOptics is fabricated.

function getFabrication

public PolarizationOpticsFabrication_Type getFabrication()

Returns the value of the Fabrication attribute.

Return: The value of the attribute

This field records the way in with which this PolarizationOptics is fabricated.

function resetFabrication

public void resetFabrication()

Resets the Fabrication attribute to an unset state.

This field records the way in with which this PolarizationOptics is fabricated.

function hasFabrication

public boolean hasFabrication()

Checks whether the optional Fabrication attribute is present.

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

This field records the way in with which this PolarizationOptics is fabricated.

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 Polarization Optics 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 Polarization Optics is made of.

function resetMaterialName

public void resetMaterialName()

Resets the MaterialName attribute to an unset state.

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

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 Polarization Optics is made of.

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

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

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

function hasGlassCode

public boolean hasGlassCode()

Checks whether the optional GlassCode attribute is present.

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

If available, this field records the international Glass Code of the material that constitutes this Lens. 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

function setWavelengthRange_List

public void setWavelengthRange_List(
    PolarizationOptics_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 PolarizationOptics_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(
    PolarizationOptics_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
)

Sets the value of the AnnotationRef element.

Parameters:

value The value to set

No description available in the XSD standard.

function getAnnotationRef

public AnnotationRef getAnnotationRef()

Returns the value of the AnnotationRef element.

Return: The value of the element

No description available in the XSD standard.

function resetAnnotationRef

public void resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

No description available in the XSD standard.

function hasAnnotationRef

public boolean hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

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

No description available in the XSD standard.

function __internal_create

public static PolarizationOptics __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.__internal_create

Protected Functions Documentation

function PolarizationOptics

protected PolarizationOptics(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.finalize

function getCPtr

protected static long getCPtr(
    PolarizationOptics obj
)

Updated on 2026-02-13 at 16:11:05 +0100