com.inscoper.nbo.GenericDichroic
Represents the XML element GenericDichroic. More...
Inherits from com.inscoper.nbo.Dichroic_Type, com.inscoper.nbo.MirroringDevice_Type, com.inscoper.nbo.ManufacturerSpec_Type, com.inscoper.nbo.NBOBaseClass
Public Functions
| Name | |
|---|---|
| synchronized void | delete() |
| GenericDichroic() | |
| 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. |
| GenericDichroic | __internal_create(long cPtr, boolean own) |
Protected Functions
| Name | |
|---|---|
| GenericDichroic(long cPtr, boolean cMemoryOwn) | |
| void | swigSetCMemOwn(boolean own) |
| void | finalize() |
| long | getCPtr(GenericDichroic obj) |
Additional inherited members
Public Functions inherited from com.inscoper.nbo.Dichroic_Type
| Name | |
|---|---|
| Dichroic_Type() | |
| void | setType(FilterType_Type value) Sets the value of the Type attribute. |
| FilterType_Type | getType() Returns the value of the Type attribute. |
| void | resetType() Resets the Type attribute to an unset state. |
| boolean | hasType() Checks whether the optional Type attribute is present. |
| void | setCoatingMethod(CoatingMethod_Type value) Sets the value of the CoatingMethod attribute. |
| CoatingMethod_Type | getCoatingMethod() Returns the value of the CoatingMethod attribute. |
| void | resetCoatingMethod() Resets the CoatingMethod attribute to an unset state. |
| boolean | hasCoatingMethod() Checks whether the optional CoatingMethod attribute is present. |
| void | setLightPathLocation(LightPathLocationOptions_Type value) Sets the value of the LightPathLocation attribute. |
| LightPathLocationOptions_Type | getLightPathLocation() Returns the value of the LightPathLocation attribute. |
| void | resetLightPathLocation() Resets the LightPathLocation attribute to an unset state. |
| boolean | hasLightPathLocation() Checks whether the optional LightPathLocation attribute is present. |
| void | setTechnology(FilterTechnologyType_Type value) Sets the value of the Technology attribute. |
| FilterTechnologyType_Type | getTechnology() Returns the value of the Technology attribute. |
| void | resetTechnology() Resets the Technology attribute to an unset state. |
| boolean | hasTechnology() Checks whether the optional Technology attribute is present. |
| void | setAttenuationMethod(AttenuationMethodType_Type value) Sets the value of the AttenuationMethod attribute. |
| AttenuationMethodType_Type | getAttenuationMethod() Returns the value of the AttenuationMethod attribute. |
| void | resetAttenuationMethod() Resets the AttenuationMethod attribute to an unset state. |
| boolean | hasAttenuationMethod() Checks whether the optional AttenuationMethod attribute is present. |
| void | setAttenuationCoefficient(float value) Sets the value of the AttenuationCoefficient attribute. |
| float | getAttenuationCoefficient() Returns the value of the AttenuationCoefficient attribute. |
| void | resetAttenuationCoefficient() Resets the AttenuationCoefficient attribute to an unset state. |
| boolean | hasAttenuationCoefficient() Checks whether the optional AttenuationCoefficient attribute is present. |
| void | setThickness(float value) Sets the value of the Thickness attribute. |
| float | getThickness() Returns the value of the Thickness attribute. |
| void | resetThickness() Resets the Thickness attribute to an unset state. |
| boolean | hasThickness() Checks whether the optional Thickness attribute is present. |
| void | setThicknessUnit(UnitsLength_Type value) Sets the value of the ThicknessUnit attribute. |
| UnitsLength_Type | getThicknessUnit() Returns the value of the ThicknessUnit attribute. |
| void | resetThicknessUnit() Resets the ThicknessUnit attribute to an unset state. |
| boolean | hasThicknessUnit() Checks whether the optional ThicknessUnit attribute is present. |
| void | setPolarization(FilterPolarizationType_Type value) Sets the value of the Polarization attribute. |
| FilterPolarizationType_Type | getPolarization() Returns the value of the Polarization attribute. |
| void | resetPolarization() Resets the Polarization attribute to an unset state. |
| boolean | hasPolarization() Checks whether the optional Polarization attribute is present. |
| 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) Adds a new TransmittanceProfileFile element to this object. |
| void | clearTransmittanceProfileFile_List() Clear the list of TransmittanceProfileFile. |
| 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) Adds a new ReflectanceProfileFile element to this object. |
| void | clearReflectanceProfileFile_List() Clear the list of ReflectanceProfileFile. |
| void | setTransmittanceRange_List(TransmittanceRangeVector value) Sets the list of TransmittanceRange elements. |
| TransmittanceRangeVector | getTransmittanceRange_List() Returns the list of TransmittanceRange elements. |
| void | addToTransmittanceRange_List(TransmittanceRange value) Adds a new TransmittanceRange element to this object. |
| void | clearTransmittanceRange_List() Clear the list of TransmittanceRange. |
| void | setReflectanceRange_List(ReflectanceRangeVector value) Sets the list of ReflectanceRange elements. |
| ReflectanceRangeVector | getReflectanceRange_List() Returns the list of ReflectanceRange elements. |
| void | addToReflectanceRange_List(ReflectanceRange value) Adds a new ReflectanceRange element to this object. |
| void | clearReflectanceRange_List() Clear the list of ReflectanceRange. |
Protected Functions inherited from com.inscoper.nbo.Dichroic_Type
| Name | |
|---|---|
| Dichroic_Type(long cPtr, boolean cMemoryOwn) |
Public Functions inherited from com.inscoper.nbo.MirroringDevice_Type
| Name | |
|---|---|
| MirroringDevice_Type() | |
| 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) 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) 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 optional OpticsHolderPosition attribute is present. |
| 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) 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) 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 optional Diameter attribute is present. |
| 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) 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 optional RadiusOfCurvature attribute is present. |
| 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) 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 optional AngleOfIncidence attribute is present. |
| 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) 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 optional SubstrateType attribute is present. |
| 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) 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 | 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. |
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) 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
Represents the XML element GenericDichroic.
A Dichroic Mirror (also often referred to as Dichroic Beamsplitter or simply as Dichroic) is a Mirror that spectrally separate light by transmitting and reflecting light as a function of wavelength. In the context of fluorescence microscopy, they are typically used to reflect the excitation light, but transmit the emitted fluorescence. Dichroic Mirrors can be categorized in different manners. However, the most important criteria for choosing a Dichoric Mirror are the Transmittance and the Reflectance Wavelength ranges. This element describes an additional Generic Dichroic positioned in the Ligth Path for one or more Channel available for this Instrument.
Public Functions Documentation
function delete
Reimplements: com.inscoper.nbo.Dichroic_Type.delete
function GenericDichroic
function getTypeName
Returns the class type name.
Return: The class type name
Reimplements: com.inscoper.nbo.Dichroic_Type.getTypeName
function getXMLName
Returns the XML element name corresponding to this class.
Return: The XML element name
Reimplements: com.inscoper.nbo.Dichroic_Type.getXMLName
function getNBOType
Returns the NBO Type corresponding to this class.
Return: The NBO Type value
Reimplements: com.inscoper.nbo.Dichroic_Type.getNBOType
function getChildren
Returns a list of all classes derived from this class.
Return: The list of derived classes
Reimplements: com.inscoper.nbo.Dichroic_Type.getChildren
function getSubElements
Returns a list of all child elements contained in this class.
Return: The list of child classes
Reimplements: com.inscoper.nbo.Dichroic_Type.getSubElements
function fromJsonFile
Populates this object from a JSON file.
Parameters:
- path The path to the JSON file
Reimplements: com.inscoper.nbo.Dichroic_Type.fromJsonFile
function fromJsonString
Populates this object from a JSON string.
Parameters:
- json_string The JSON content as a string
Reimplements: com.inscoper.nbo.Dichroic_Type.fromJsonString
function fromXmlFile
Populates this object from a XML file.
Parameters:
- path The path to the XML file
Reimplements: com.inscoper.nbo.Dichroic_Type.fromXmlFile
function fromXmlString
Populates this object from a XML string.
Parameters:
- xml_string The XML content as a string
Reimplements: com.inscoper.nbo.Dichroic_Type.fromXmlString
function toXmlFile
Serializes this object to an XML file.
Parameters:
- filename The path to the output XML file
Reimplements: com.inscoper.nbo.Dichroic_Type.toXmlFile
function toXmlString
Serializes this object to an XML string.
Return: A string containing the XML representation of this object
Reimplements: com.inscoper.nbo.Dichroic_Type.toXmlString
function __internal_create
Reimplements: com.inscoper.nbo.Dichroic_Type.__internal_create
Protected Functions Documentation
function GenericDichroic
function swigSetCMemOwn
Reimplements: com.inscoper.nbo.Dichroic_Type.swigSetCMemOwn
function finalize
Reimplements: com.inscoper.nbo.Dichroic_Type.finalize
function getCPtr
Updated on 2026-02-13 at 16:10:58 +0100