com.inscoper.nbo.PhotoDiode

Represents the XML element PhotoDiode. More...

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

Public Functions

	Name
synchronized void	delete()
	PhotoDiode()
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	setAvalanche(boolean value) Sets the value of the Avalanche attribute.
boolean	getAvalanche() Returns the value of the Avalanche attribute.
void	resetAvalanche() Resets the Avalanche attribute to an unset state.
boolean	hasAvalanche() Checks whether the optional Avalanche attribute is present.
void	setPINJunction(boolean value) Sets the value of the PINJunction attribute.
boolean	getPINJunction() Returns the value of the PINJunction attribute.
void	resetPINJunction() Resets the PINJunction attribute to an unset state.
boolean	hasPINJunction() Checks whether the optional PINJunction attribute is present.
PhotoDiode	__internal_create(long cPtr, boolean own)

Protected Functions

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

Additional inherited members

Public Functions inherited from com.inscoper.nbo.PointDetector_Type

	Name
	PointDetector_Type()
void	setCoating(CoatingMaterial_Type value) Sets the value of the Coating attribute.
CoatingMaterial_Type	getCoating() Returns the value of the Coating attribute.
void	resetCoating() Resets the Coating attribute to an unset state.
boolean	hasCoating() Checks whether the optional Coating attribute is present.
void	setSignalProcessing(SignalProcessingMode_Type value) Sets the value of the SignalProcessing attribute.
SignalProcessingMode_Type	getSignalProcessing() Returns the value of the SignalProcessing attribute.
void	resetSignalProcessing() Resets the SignalProcessing attribute to an unset state.
boolean	hasSignalProcessing() Checks whether the optional SignalProcessing attribute is present.
void	setResponseTime(float value) Sets the value of the ResponseTime attribute.
float	getResponseTime() Returns the value of the ResponseTime attribute.
void	resetResponseTime() Resets the ResponseTime attribute to an unset state.
boolean	hasResponseTime() Checks whether the optional ResponseTime attribute is present.
void	setResponseTimeUnit(UnitsTime_Type value) Sets the value of the ResponseTimeUnit attribute.
UnitsTime_Type	getResponseTimeUnit() Returns the value of the ResponseTimeUnit attribute.
void	resetResponseTimeUnit() Resets the ResponseTimeUnit attribute to an unset state.
boolean	hasResponseTimeUnit() Checks whether the optional ResponseTimeUnit attribute is present.
void	setDeadTime(float value) Sets the value of the DeadTime attribute.
float	getDeadTime() Returns the value of the DeadTime attribute.
void	resetDeadTime() Resets the DeadTime attribute to an unset state.
boolean	hasDeadTime() Checks whether the optional DeadTime attribute is present.
void	setDeadTimeUnit(UnitsTime_Type value) Sets the value of the DeadTimeUnit attribute.
UnitsTime_Type	getDeadTimeUnit() Returns the value of the DeadTimeUnit attribute.
void	resetDeadTimeUnit() Resets the DeadTimeUnit attribute to an unset state.
boolean	hasDeadTimeUnit() Checks whether the optional DeadTimeUnit attribute is present.
void	setRadiantSensitivity(float value) Sets the value of the RadiantSensitivity attribute.
float	getRadiantSensitivity() Returns the value of the RadiantSensitivity attribute.
void	resetRadiantSensitivity() Resets the RadiantSensitivity attribute to an unset state.
boolean	hasRadiantSensitivity() Checks whether the optional RadiantSensitivity attribute is present.
void	setRadiantSensitivityUnit(UnitsPower_Type value) Sets the value of the RadiantSensitivityUnit attribute.
UnitsPower_Type	getRadiantSensitivityUnit() Returns the value of the RadiantSensitivityUnit attribute.
void	resetRadiantSensitivityUnit() Resets the RadiantSensitivityUnit attribute to an unset state.
boolean	hasRadiantSensitivityUnit() Checks whether the optional RadiantSensitivityUnit attribute is present.

Protected Functions inherited from com.inscoper.nbo.PointDetector_Type

	Name
	PointDetector_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.Detector_Type

	Name
	Detector_Type()
void	setID(DetectorID_Type value) Sets the value of the ID attribute.
DetectorID_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	setMount(DetectorMount_Type value) Sets the value of the Mount attribute.
DetectorMount_Type	getMount() Returns the value of the Mount attribute.
void	resetMount() Resets the Mount attribute to an unset state.
boolean	hasMount() Checks whether the optional Mount attribute is present.
void	setMaxBitDepth(DigitizerType_Type value) Sets the value of the MaxBitDepth attribute.
DigitizerType_Type	getMaxBitDepth() Returns the value of the MaxBitDepth attribute.
void	resetMaxBitDepth() Resets the MaxBitDepth attribute to an unset state.
boolean	hasMaxBitDepth() Checks whether the optional MaxBitDepth attribute is present.
void	setQuantumEfficiency(float value) Sets the value of the QuantumEfficiency attribute.
float	getQuantumEfficiency() Returns the value of the QuantumEfficiency attribute.
void	setElectronicConversionFactor(float value) Sets the value of the ElectronicConversionFactor attribute.
float	getElectronicConversionFactor() Returns the value of the ElectronicConversionFactor attribute.
void	setReadOutNoise(float value) Sets the value of the ReadOutNoise attribute.
float	getReadOutNoise() Returns the value of the ReadOutNoise attribute.
void	setReadNoiseUnit(UnitsElectricCurrent_Type value) Sets the value of the ReadNoiseUnit attribute.
UnitsElectricCurrent_Type	getReadNoiseUnit() Returns the value of the ReadNoiseUnit attribute.
void	resetReadNoiseUnit() Resets the ReadNoiseUnit attribute to an unset state.
boolean	hasReadNoiseUnit() Checks whether the optional ReadNoiseUnit attribute is present.
void	setDetectorNoiseModel(DetectorNoiseModel_Type value) Sets the value of the DetectorNoiseModel attribute.
DetectorNoiseModel_Type	getDetectorNoiseModel() Returns the value of the DetectorNoiseModel attribute.
void	resetDetectorNoiseModel() Resets the DetectorNoiseModel attribute to an unset state.
boolean	hasDetectorNoiseModel() Checks whether the optional DetectorNoiseModel attribute is present.
void	setDarkCurrentRate(float value) Sets the value of the DarkCurrentRate attribute.
float	getDarkCurrentRate() Returns the value of the DarkCurrentRate attribute.
void	setDarkCurrentRateUnit(UnitsElectricCurrent_Type value) Sets the value of the DarkCurrentRateUnit attribute.
UnitsElectricCurrent_Type	getDarkCurrentRateUnit() Returns the value of the DarkCurrentRateUnit attribute.
void	resetDarkCurrentRateUnit() Resets the DarkCurrentRateUnit attribute to an unset state.
boolean	hasDarkCurrentRateUnit() Checks whether the optional DarkCurrentRateUnit attribute is present.
void	setDynamicRange(float value) Sets the value of the DynamicRange attribute.
float	getDynamicRange() Returns the value of the DynamicRange attribute.
void	resetDynamicRange() Resets the DynamicRange attribute to an unset state.
boolean	hasDynamicRange() Checks whether the optional DynamicRange attribute is present.
void	setDynamicRangeUnit(UnitsRatio_Type value) Sets the value of the DynamicRangeUnit attribute.
UnitsRatio_Type	getDynamicRangeUnit() Returns the value of the DynamicRangeUnit attribute.
void	resetDynamicRangeUnit() Resets the DynamicRangeUnit attribute to an unset state.
boolean	hasDynamicRangeUnit() Checks whether the optional DynamicRangeUnit attribute is present.
void	setAmbientOperatingTemperature(float value) Sets the value of the AmbientOperatingTemperature attribute.
float	getAmbientOperatingTemperature() Returns the value of the AmbientOperatingTemperature attribute.
void	resetAmbientOperatingTemperature() Resets the AmbientOperatingTemperature attribute to an unset state.
boolean	hasAmbientOperatingTemperature() Checks whether the optional AmbientOperatingTemperature attribute is present.
void	setAmbientOperatingTemperatureUnit(UnitsTemperature_Type value) Sets the value of the AmbientOperatingTemperatureUnit attribute.
UnitsTemperature_Type	getAmbientOperatingTemperatureUnit() Returns the value of the AmbientOperatingTemperatureUnit attribute.
void	resetAmbientOperatingTemperatureUnit() Resets the AmbientOperatingTemperatureUnit attribute to an unset state.
boolean	hasAmbientOperatingTemperatureUnit() Checks whether the optional AmbientOperatingTemperatureUnit attribute is present.
void	setAmbientOperatingHumidity(float value) Sets the value of the AmbientOperatingHumidity attribute.
float	getAmbientOperatingHumidity() Returns the value of the AmbientOperatingHumidity attribute.
void	resetAmbientOperatingHumidity() Resets the AmbientOperatingHumidity attribute to an unset state.
boolean	hasAmbientOperatingHumidity() Checks whether the optional AmbientOperatingHumidity attribute is present.
void	setRelayLensRef(LensRef_Type value) Sets the value of the RelayLensRef element.
LensRef_Type	getRelayLensRef() Returns the value of the RelayLensRef element.
void	resetRelayLensRef() Resets the RelayLensRef element to an unset state.
boolean	hasRelayLensRef() Checks whether the optional RelayLensRef element is present.
void	setAnnotationRef_List(AnnotationRefVector value) Sets the list of AnnotationRef elements.
AnnotationRefVector	getAnnotationRef_List() Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(AnnotationRef value) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
void	setWavelengthRange_List(Detector_Type_InlineWavelengthRangeVector value) Sets the list of WavelengthRange elements.
Detector_Type_InlineWavelengthRangeVector	getWavelengthRange_List() Returns the list of WavelengthRange elements.
void	addToWavelengthRange_List(Detector_Type_InlineWavelengthRange value) Adds a new WavelengthRange element to this object.
void	clearWavelengthRange_List() Clear the list of WavelengthRange.

Protected Functions inherited from com.inscoper.nbo.Detector_Type

	Name
	Detector_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

public class com.inscoper.nbo.PhotoDiode;

Represents the XML element PhotoDiode.

This element represents a Photovoltaic Detector. Most photodiodes used in confocal microscopes are Avalanche Photodiode (APD) which because of the amplification gain have good sensitivities and less dark current.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.PointDetector_Type.delete

function PhotoDiode

public PhotoDiode()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.PointDetector_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.PointDetector_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.PointDetector_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.PointDetector_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.PointDetector_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.PointDetector_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.PointDetector_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.PointDetector_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.PointDetector_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.PointDetector_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.PointDetector_Type.toXmlString

function setAvalanche

public void setAvalanche(
    boolean value
)

Sets the value of the Avalanche attribute.

Parameters:

value The value to set

This field records whether (True) or not (False) this is an Avalanche Photodiode.

function getAvalanche

public boolean getAvalanche()

Returns the value of the Avalanche attribute.

Return: The value of the attribute

This field records whether (True) or not (False) this is an Avalanche Photodiode.

function resetAvalanche

public void resetAvalanche()

Resets the Avalanche attribute to an unset state.

This field records whether (True) or not (False) this is an Avalanche Photodiode.

function hasAvalanche

public boolean hasAvalanche()

Checks whether the optional Avalanche attribute is present.

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

This field records whether (True) or not (False) this is an Avalanche Photodiode.

function setPINJunction

public void setPINJunction(
    boolean value
)

Sets the value of the PINJunction attribute.

Parameters:

value The value to set

This field records whether this photodiode is based on a Positive-Intermediate-Negative (PIN) or a Positive-Negative (PN) architecture.

function getPINJunction

public boolean getPINJunction()

Returns the value of the PINJunction attribute.

Return: The value of the attribute

This field records whether this photodiode is based on a Positive-Intermediate-Negative (PIN) or a Positive-Negative (PN) architecture.

function resetPINJunction

public void resetPINJunction()

Resets the PINJunction attribute to an unset state.

This field records whether this photodiode is based on a Positive-Intermediate-Negative (PIN) or a Positive-Negative (PN) architecture.

function hasPINJunction

public boolean hasPINJunction()

Checks whether the optional PINJunction attribute is present.

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

This field records whether this photodiode is based on a Positive-Intermediate-Negative (PIN) or a Positive-Negative (PN) architecture.

function __internal_create

public static PhotoDiode __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.PointDetector_Type.__internal_create

Protected Functions Documentation

function PhotoDiode

protected PhotoDiode(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.PointDetector_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.PointDetector_Type.finalize

function getCPtr

protected static long getCPtr(
    PhotoDiode obj
)

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