com.inscoper.nbo.Pinhole

Represents the XML element Pinhole. More...

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

Public Functions

	Name
synchronized void	delete()
	Pinhole()
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	setMaxDiameter(float value) Sets the value of the MaxDiameter attribute.
float	getMaxDiameter() Returns the value of the MaxDiameter attribute.
void	setMaxDiameterUnit(UnitsLength_Type value) Sets the value of the MaxDiameterUnit attribute.
UnitsLength_Type	getMaxDiameterUnit() Returns the value of the MaxDiameterUnit attribute.
void	resetMaxDiameterUnit() Resets the MaxDiameterUnit attribute to an unset state.
boolean	hasMaxDiameterUnit() Checks whether the optional MaxDiameterUnit attribute is present.
void	setShape(PinholeShapeList_Type value) Sets the value of the Shape attribute.
PinholeShapeList_Type	getShape() Returns the value of the Shape attribute.
void	resetShape() Resets the Shape attribute to an unset state.
boolean	hasShape() Checks whether the optional Shape attribute is present.
Pinhole	__internal_create(long cPtr, boolean own)

Protected Functions

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

Additional inherited members

Public Functions inherited from com.inscoper.nbo.OpticalAperture_Type

	Name
	OpticalAperture_Type()
void	setID(LensID_Type value) Sets the value of the ID attribute.
LensID_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	setOuterDiameter(float value) Sets the value of the OuterDiameter attribute.
float	getOuterDiameter() Returns the value of the OuterDiameter attribute.
void	resetOuterDiameter() Resets the OuterDiameter attribute to an unset state.
boolean	hasOuterDiameter() Checks whether the optional OuterDiameter attribute is present.
void	setOuterDiameterUnit(UnitsLength_Type value) Sets the value of the OuterDiameterUnit attribute.
UnitsLength_Type	getOuterDiameterUnit() Returns the value of the OuterDiameterUnit attribute.
void	resetOuterDiameterUnit() Resets the OuterDiameterUnit attribute to an unset state.
boolean	hasOuterDiameterUnit() Checks whether the optional OuterDiameterUnit 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.OpticalAperture_Type

	Name
	OpticalAperture_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.Pinhole;

Represents the XML element Pinhole.

A pin-like aperture positioned axially to the Light Path, which can act as a spatial filter for a beam of light to clean up the output of lasers and / or to suppress out-of-focus light in a confocal Microscope. Specifically, in Confocal Microscopy, such Pinholes are diaphragm typically situated in a plane conjugate with the object, and they restrict the area in the object plane that is illuminated and/or from which light is collected.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.OpticalAperture_Type.delete

function Pinhole

public Pinhole()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.OpticalAperture_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.OpticalAperture_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_Type.toXmlString

function setMaxDiameter

public void setMaxDiameter(
    float value
)

Sets the value of the MaxDiameter attribute.

Parameters:

value The value to set

This field records the maximum physical diameter of this Pinhole.

function getMaxDiameter

public float getMaxDiameter()

Returns the value of the MaxDiameter attribute.

Return: The value of the attribute

This field records the maximum physical diameter of this Pinhole.

function setMaxDiameterUnit

public void setMaxDiameterUnit(
    UnitsLength_Type value
)

Sets the value of the MaxDiameterUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getMaxDiameterUnit

public UnitsLength_Type getMaxDiameterUnit()

Returns the value of the MaxDiameterUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetMaxDiameterUnit

public void resetMaxDiameterUnit()

Resets the MaxDiameterUnit attribute to an unset state.

No description available in the XSD standard.

function hasMaxDiameterUnit

public boolean hasMaxDiameterUnit()

Checks whether the optional MaxDiameterUnit attribute is present.

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

No description available in the XSD standard.

function setShape

public void setShape(
    PinholeShapeList_Type value
)

Sets the value of the Shape attribute.

Parameters:

value The value to set

This field records the Shape of this Pinhole.

function getShape

public PinholeShapeList_Type getShape()

Returns the value of the Shape attribute.

Return: The value of the attribute

This field records the Shape of this Pinhole.

function resetShape

public void resetShape()

Resets the Shape attribute to an unset state.

This field records the Shape of this Pinhole.

function hasShape

public boolean hasShape()

Checks whether the optional Shape attribute is present.

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

This field records the Shape of this Pinhole.

function __internal_create

public static Pinhole __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.OpticalAperture_Type.__internal_create

Protected Functions Documentation

function Pinhole

protected Pinhole(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.OpticalAperture_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.OpticalAperture_Type.finalize

function getCPtr

protected static long getCPtr(
    Pinhole obj
)

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