com.inscoper.nbo.BeamSplitter¶

Represents the XML element BeamSplitter. More...

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

Public Functions¶

	Name
synchronized void	delete()
	BeamSplitter()
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	setTransmittance(float value, boolean validate) Sets the value of the Transmittance attribute.
void	setTransmittance(float value) Sets the value of the Transmittance attribute.
float	getTransmittance() Returns the value of the Transmittance attribute.
void	resetTransmittance() Resets the Transmittance attribute to an unset state.
boolean	hasTransmittance() Checks whether the Transmittance attribute is present.
void	setTransmittanceProfileFile(String value, boolean validate) Sets the value of the TransmittanceProfileFile attribute.
void	setTransmittanceProfileFile(String value) Sets the value of the TransmittanceProfileFile attribute.
String	getTransmittanceProfileFile() Returns the value of the TransmittanceProfileFile attribute.
void	resetTransmittanceProfileFile() Resets the TransmittanceProfileFile attribute to an unset state.
boolean	hasTransmittanceProfileFile() Checks whether the TransmittanceProfileFile attribute is present.
void	setTransmissionAngle(float value, boolean validate) Sets the value of the TransmissionAngle attribute.
void	setTransmissionAngle(float value) Sets the value of the TransmissionAngle attribute.
float	getTransmissionAngle() Returns the value of the TransmissionAngle attribute.
void	resetTransmissionAngle() Resets the TransmissionAngle attribute to an unset state.
boolean	hasTransmissionAngle() Checks whether the TransmissionAngle attribute is present.
void	setTransmissionAngleUnit(UnitsAngle_Type value, boolean validate) Sets the value of the TransmissionAngleUnit attribute.
void	setTransmissionAngleUnit(UnitsAngle_Type value) Sets the value of the TransmissionAngleUnit attribute.
UnitsAngle_Type	getTransmissionAngleUnit() Returns the value of the TransmissionAngleUnit attribute.
void	resetTransmissionAngleUnit() Resets the TransmissionAngleUnit attribute to an unset state.
boolean	hasTransmissionAngleUnit() Checks whether the optional TransmissionAngleUnit 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	setTransmittanceProfileFile_List(TransmittanceProfileFileVector value, boolean validate) Sets the list of TransmittanceProfileFile elements.
void	setTransmittanceProfileFile_List(TransmittanceProfileFileVector value) Sets the list of TransmittanceProfileFile elements.
TransmittanceProfileFileVector	getTransmittanceProfileFile_List() Returns the list of TransmittanceProfileFile elements.
void	addToTransmittanceProfileFile_List(TransmittanceProfileFile value, boolean validate) Adds a new TransmittanceProfileFile element to this object.
void	addToTransmittanceProfileFile_List(TransmittanceProfileFile value) Adds a new TransmittanceProfileFile element to this object.
void	clearTransmittanceProfileFile_List() Clear the list of TransmittanceProfileFile.
void	setReflectanceProfileFile_List(ReflectanceProfileFileVector value, boolean validate) Sets the list of ReflectanceProfileFile elements.
void	setReflectanceProfileFile_List(ReflectanceProfileFileVector value) Sets the list of ReflectanceProfileFile elements.
ReflectanceProfileFileVector	getReflectanceProfileFile_List() Returns the list of ReflectanceProfileFile elements.
void	addToReflectanceProfileFile_List(ReflectanceProfileFile value, boolean validate) Adds a new ReflectanceProfileFile element to this object.
void	addToReflectanceProfileFile_List(ReflectanceProfileFile value) Adds a new ReflectanceProfileFile element to this object.
void	clearReflectanceProfileFile_List() Clear the list of ReflectanceProfileFile.
BeamSplitter	__internal_create(long cPtr, boolean own)
BeamSplitter	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.
StringSet	getTransmittanceProfileFileAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.MirroringDevice_Type

	Name
	MirroringDevice_Type()
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.
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 inherited from com.inscoper.nbo.MirroringDevice_Type

	Name
	MirroringDevice_Type(long cPtr, boolean cMemoryOwn)

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

Represents the XML element BeamSplitter.

This element describes a Mirror that reflects part of the light, regardless of wavelength.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.MirroringDevice_Type.delete

function BeamSplitter¶

public BeamSplitter()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.MirroringDevice_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.MirroringDevice_Type.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.MirroringDevice_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.MirroringDevice_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.MirroringDevice_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.MirroringDevice_Type.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.MirroringDevice_Type.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.MirroringDevice_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.MirroringDevice_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.MirroringDevice_Type.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.MirroringDevice_Type.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.MirroringDevice_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.MirroringDevice_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.MirroringDevice_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.MirroringDevice_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.MirroringDevice_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.MirroringDevice_Type.toXmlString

function setTransmittance¶

public void setTransmittance(
    float value,
    boolean validate
)

Sets the value of the Transmittance attribute.

Parameters:

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

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

function setTransmittance¶

public void setTransmittance(
    float value
)

Sets the value of the Transmittance attribute.

Parameters:

value The value to set

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

function getTransmittance¶

public float getTransmittance()

Returns the value of the Transmittance attribute.

Return: The value of the attribute

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

function resetTransmittance¶

public void resetTransmittance()

Resets the Transmittance attribute to an unset state.

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

function hasTransmittance¶

public boolean hasTransmittance()

Checks whether the Transmittance attribute is present.

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

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

function setTransmittanceProfileFile¶

public void setTransmittanceProfileFile(
    String value,
    boolean validate
)

Sets the value of the TransmittanceProfileFile attribute.

Parameters:

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

This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.

function setTransmittanceProfileFile¶

public void setTransmittanceProfileFile(
    String value
)

Sets the value of the TransmittanceProfileFile attribute.

Parameters:

value The value to set

This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.

function getTransmittanceProfileFile¶

public String getTransmittanceProfileFile()

Returns the value of the TransmittanceProfileFile attribute.

Return: The value of the attribute

This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.

function resetTransmittanceProfileFile¶

public void resetTransmittanceProfileFile()

Resets the TransmittanceProfileFile attribute to an unset state.

This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.

function hasTransmittanceProfileFile¶

public boolean hasTransmittanceProfileFile()

Checks whether the TransmittanceProfileFile attribute is present.

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

This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.

function setTransmissionAngle¶

public void setTransmissionAngle(
    float value,
    boolean validate
)

Sets the value of the TransmissionAngle attribute.

Parameters:

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

The angle at which light is transmitted by this Beamsplitter.

function setTransmissionAngle¶

public void setTransmissionAngle(
    float value
)

Sets the value of the TransmissionAngle attribute.

Parameters:

value The value to set

The angle at which light is transmitted by this Beamsplitter.

function getTransmissionAngle¶

public float getTransmissionAngle()

Returns the value of the TransmissionAngle attribute.

Return: The value of the attribute

The angle at which light is transmitted by this Beamsplitter.

function resetTransmissionAngle¶

public void resetTransmissionAngle()

Resets the TransmissionAngle attribute to an unset state.

The angle at which light is transmitted by this Beamsplitter.

function hasTransmissionAngle¶

public boolean hasTransmissionAngle()

Checks whether the TransmissionAngle attribute is present.

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

The angle at which light is transmitted by this Beamsplitter.

function setTransmissionAngleUnit¶

public void setTransmissionAngleUnit(
    UnitsAngle_Type value,
    boolean validate
)

Sets the value of the TransmissionAngleUnit 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 setTransmissionAngleUnit¶

public void setTransmissionAngleUnit(
    UnitsAngle_Type value
)

Sets the value of the TransmissionAngleUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getTransmissionAngleUnit¶

public UnitsAngle_Type getTransmissionAngleUnit()

Returns the value of the TransmissionAngleUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetTransmissionAngleUnit¶

public void resetTransmissionAngleUnit()

Resets the TransmissionAngleUnit attribute to an unset state.

No description available in the XSD standard.

function hasTransmissionAngleUnit¶

public boolean hasTransmissionAngleUnit()

Checks whether the optional TransmissionAngleUnit attribute is present.

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

No description available in the XSD standard.

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.

The field records the maximum amount of light this Beamsplitteris capable of reflecting at the 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

The field records the maximum amount of light this Beamsplitteris capable of reflecting at the 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

The field records the maximum amount of light this Beamsplitteris capable of reflecting at the 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.

The field records the maximum amount of light this Beamsplitteris capable of reflecting at the 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

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

function setTransmittanceProfileFile_List¶

public void setTransmittanceProfileFile_List(
    TransmittanceProfileFileVector value,
    boolean validate
)

Sets the list of TransmittanceProfileFile elements.

Parameters:

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

No description available in the XSD standard.

function setTransmittanceProfileFile_List¶

public void setTransmittanceProfileFile_List(
    TransmittanceProfileFileVector value
)

Sets the list of TransmittanceProfileFile elements.

Parameters:

value The new list of TransmittanceProfileFile elements

No description available in the XSD standard.

function getTransmittanceProfileFile_List¶

public TransmittanceProfileFileVector getTransmittanceProfileFile_List()

Returns the list of TransmittanceProfileFile elements.

Return: The list of TransmittanceProfileFile elements

No description available in the XSD standard.

function addToTransmittanceProfileFile_List¶

public void addToTransmittanceProfileFile_List(
    TransmittanceProfileFile value,
    boolean validate
)

Adds a new TransmittanceProfileFile element to this object.

Parameters:

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

No description available in the XSD standard.

function addToTransmittanceProfileFile_List¶

public void addToTransmittanceProfileFile_List(
    TransmittanceProfileFile value
)

Adds a new TransmittanceProfileFile element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearTransmittanceProfileFile_List¶

public void clearTransmittanceProfileFile_List()

Clear the list of TransmittanceProfileFile.

No description available in the XSD standard.

function setReflectanceProfileFile_List¶

public void setReflectanceProfileFile_List(
    ReflectanceProfileFileVector value,
    boolean validate
)

Sets the list of ReflectanceProfileFile elements.

Parameters:

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

No description available in the XSD standard.

function setReflectanceProfileFile_List¶

public void setReflectanceProfileFile_List(
    ReflectanceProfileFileVector value
)

Sets the list of ReflectanceProfileFile elements.

Parameters:

value The new list of ReflectanceProfileFile elements

No description available in the XSD standard.

function getReflectanceProfileFile_List¶

public ReflectanceProfileFileVector getReflectanceProfileFile_List()

Returns the list of ReflectanceProfileFile elements.

Return: The list of ReflectanceProfileFile elements

No description available in the XSD standard.

function addToReflectanceProfileFile_List¶

public void addToReflectanceProfileFile_List(
    ReflectanceProfileFile value,
    boolean validate
)

Adds a new ReflectanceProfileFile element to this object.

Parameters:

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

No description available in the XSD standard.

function addToReflectanceProfileFile_List¶

public void addToReflectanceProfileFile_List(
    ReflectanceProfileFile value
)

Adds a new ReflectanceProfileFile element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearReflectanceProfileFile_List¶

public void clearReflectanceProfileFile_List()

Clear the list of ReflectanceProfileFile.

No description available in the XSD standard.

function __internal_create¶

public static BeamSplitter __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.MirroringDevice_Type.__internal_create

function fromBase¶

public static BeamSplitter fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.MirroringDevice_Type.fromBase

function getTransmittanceProfileFileAllowedValues¶

public static StringSet getTransmittanceProfileFileAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

This field records the location of a file in .csv or other suitable formats containing the Transmittance profile of this optical component.

Protected Functions Documentation¶

function BeamSplitter¶

protected BeamSplitter(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.MirroringDevice_Type.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.MirroringDevice_Type.finalize

function getCPtr¶

protected static long getCPtr(
    BeamSplitter obj
)

Updated on 2026-06-22 at 17:06:23 +0200