com.inscoper.nbo.Instrument

Represents the XML element Instrument. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	Instrument()
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	fromMicroMetaAppJsonFile(String path) Populates this object from a JSON file generated by MicroMeta App.
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(InstrumentID_Type value) Sets the value of the ID attribute.
InstrumentID_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	setMicroscopeStandGroup_List(MicroscopeStand_TypeVector value) Sets the list of MicroscopeStandGroup elements.
MicroscopeStand_TypeVector	getMicroscopeStandGroup_List() Returns the list of MicroscopeStandGroup elements.
void	addToMicroscopeStandGroup_List(MicroscopeStand_Type value) Adds a new MicroscopeStandGroup element to this object.
void	clearMicroscopeStandGroup_List() Clear the list of MicroscopeStandGroup.
void	setMicroscopeTable_List(MicroscopeTableVector value) Sets the list of MicroscopeTable elements.
MicroscopeTableVector	getMicroscopeTable_List() Returns the list of MicroscopeTable elements.
void	addToMicroscopeTable_List(MicroscopeTable value) Adds a new MicroscopeTable element to this object.
void	clearMicroscopeTable_List() Clear the list of MicroscopeTable.
void	setSoftwareGroup_List(Software_TypeVector value) Sets the list of SoftwareGroup elements.
Software_TypeVector	getSoftwareGroup_List() Returns the list of SoftwareGroup elements.
void	addToSoftwareGroup_List(Software_Type value) Adds a new SoftwareGroup element to this object.
void	clearSoftwareGroup_List() Clear the list of SoftwareGroup.
void	setEnvironmentalControlDevice_List(EnvironmentalControlDeviceVector value) Sets the list of EnvironmentalControlDevice elements.
EnvironmentalControlDeviceVector	getEnvironmentalControlDevice_List() Returns the list of EnvironmentalControlDevice elements.
void	addToEnvironmentalControlDevice_List(EnvironmentalControlDevice value) Adds a new EnvironmentalControlDevice element to this object.
void	clearEnvironmentalControlDevice_List() Clear the list of EnvironmentalControlDevice.
void	setLightSourceGroup_List(LightSource_TypeVector value) Sets the list of LightSourceGroup elements.
LightSource_TypeVector	getLightSourceGroup_List() Returns the list of LightSourceGroup elements.
void	addToLightSourceGroup_List(LightSource_Type value) Adds a new LightSourceGroup element to this object.
void	clearLightSourceGroup_List() Clear the list of LightSourceGroup.
void	setLightSourceCouplingGroup_List(LightSourceCoupling_TypeVector value) Sets the list of LightSourceCouplingGroup elements.
LightSourceCoupling_TypeVector	getLightSourceCouplingGroup_List() Returns the list of LightSourceCouplingGroup elements.
void	addToLightSourceCouplingGroup_List(LightSourceCoupling_Type value) Adds a new LightSourceCouplingGroup element to this object.
void	clearLightSourceCouplingGroup_List() Clear the list of LightSourceCouplingGroup.
void	setObjective_List(ObjectiveVector value) Sets the list of Objective elements.
ObjectiveVector	getObjective_List() Returns the list of Objective elements.
void	addToObjective_List(Objective value) Adds a new Objective element to this object.
void	clearObjective_List() Clear the list of Objective.
void	setOpticalAssemblyGroup_List(OpticalAssembly_TypeVector value) Sets the list of OpticalAssemblyGroup elements.
OpticalAssembly_TypeVector	getOpticalAssemblyGroup_List() Returns the list of OpticalAssemblyGroup elements.
void	addToOpticalAssemblyGroup_List(OpticalAssembly_Type value) Adds a new OpticalAssemblyGroup element to this object.
void	clearOpticalAssemblyGroup_List() Clear the list of OpticalAssemblyGroup.
void	setOpticalApertureGroup_List(OpticalAperture_TypeVector value) Sets the list of OpticalApertureGroup elements.
OpticalAperture_TypeVector	getOpticalApertureGroup_List() Returns the list of OpticalApertureGroup elements.
void	addToOpticalApertureGroup_List(OpticalAperture_Type value) Adds a new OpticalApertureGroup element to this object.
void	clearOpticalApertureGroup_List() Clear the list of OpticalApertureGroup.
void	setStageInsert_List(StageInsertVector value) Sets the list of StageInsert elements.
StageInsertVector	getStageInsert_List() Returns the list of StageInsert elements.
void	addToStageInsert_List(StageInsert value) Adds a new StageInsert element to this object.
void	clearStageInsert_List() Clear the list of StageInsert.
void	setSamplePositioningGroup_List(SamplePositioning_TypeVector value) Sets the list of SamplePositioningGroup elements.
SamplePositioning_TypeVector	getSamplePositioningGroup_List() Returns the list of SamplePositioningGroup elements.
void	addToSamplePositioningGroup_List(SamplePositioning_Type value) Adds a new SamplePositioningGroup element to this object.
void	clearSamplePositioningGroup_List() Clear the list of SamplePositioningGroup.
void	setFocusStabilizationDevice_List(FocusStabilizationDeviceVector value) Sets the list of FocusStabilizationDevice elements.
FocusStabilizationDeviceVector	getFocusStabilizationDevice_List() Returns the list of FocusStabilizationDevice elements.
void	addToFocusStabilizationDevice_List(FocusStabilizationDevice value) Adds a new FocusStabilizationDevice element to this object.
void	clearFocusStabilizationDevice_List() Clear the list of FocusStabilizationDevice.
void	setOpticsHolderGroup_List(OpticsHolder_TypeVector value) Sets the list of OpticsHolderGroup elements.
OpticsHolder_TypeVector	getOpticsHolderGroup_List() Returns the list of OpticsHolderGroup elements.
void	addToOpticsHolderGroup_List(OpticsHolder_Type value) Adds a new OpticsHolderGroup element to this object.
void	clearOpticsHolderGroup_List() Clear the list of OpticsHolderGroup.
void	setFilterGroup_List(Filter_TypeVector value) Sets the list of FilterGroup elements.
Filter_TypeVector	getFilterGroup_List() Returns the list of FilterGroup elements.
void	addToFilterGroup_List(Filter_Type value) Adds a new FilterGroup element to this object.
void	clearFilterGroup_List() Clear the list of FilterGroup.
void	setMirroringDeviceGroup_List(MirroringDevice_TypeVector value) Sets the list of MirroringDeviceGroup elements.
MirroringDevice_TypeVector	getMirroringDeviceGroup_List() Returns the list of MirroringDeviceGroup elements.
void	addToMirroringDeviceGroup_List(MirroringDevice_Type value) Adds a new MirroringDeviceGroup element to this object.
void	clearMirroringDeviceGroup_List() Clear the list of MirroringDeviceGroup.
void	setLensGroup_List(Lens_TypeVector value) Sets the list of LensGroup elements.
Lens_TypeVector	getLensGroup_List() Returns the list of LensGroup elements.
void	addToLensGroup_List(Lens_Type value) Adds a new LensGroup element to this object.
void	clearLensGroup_List() Clear the list of LensGroup.
void	setPrism_List(PrismVector value) Sets the list of Prism elements.
PrismVector	getPrism_List() Returns the list of Prism elements.
void	addToPrism_List(Prism value) Adds a new Prism element to this object.
void	clearPrism_List() Clear the list of Prism.
void	setPolarizationOptics_List(PolarizationOpticsVector value) Sets the list of PolarizationOptics elements.
PolarizationOpticsVector	getPolarizationOptics_List() Returns the list of PolarizationOptics elements.
void	addToPolarizationOptics_List(PolarizationOptics value) Adds a new PolarizationOptics element to this object.
void	clearPolarizationOptics_List() Clear the list of PolarizationOptics.
void	setDetectorGroup_List(Detector_TypeVector value) Sets the list of DetectorGroup elements.
Detector_TypeVector	getDetectorGroup_List() Returns the list of DetectorGroup elements.
void	addToDetectorGroup_List(Detector_Type value) Adds a new DetectorGroup element to this object.
void	clearDetectorGroup_List() Clear the list of DetectorGroup.
void	setTIRFHardwareModule_List(TIRFHardwareModuleVector value) Sets the list of TIRFHardwareModule elements.
TIRFHardwareModuleVector	getTIRFHardwareModule_List() Returns the list of TIRFHardwareModule elements.
void	addToTIRFHardwareModule_List(TIRFHardwareModule value) Adds a new TIRFHardwareModule element to this object.
void	clearTIRFHardwareModule_List() Clear the list of TIRFHardwareModule.
void	setConfocalScannerGroup_List(ConfocalScanner_TypeVector value) Sets the list of ConfocalScannerGroup elements.
ConfocalScanner_TypeVector	getConfocalScannerGroup_List() Returns the list of ConfocalScannerGroup elements.
void	addToConfocalScannerGroup_List(ConfocalScanner_Type value) Adds a new ConfocalScannerGroup element to this object.
void	clearConfocalScannerGroup_List() Clear the list of ConfocalScannerGroup.
void	setAcoustoOpticalDeviceGroup_List(AcoustoOpticalDevice_TypeVector value) Sets the list of AcoustoOpticalDeviceGroup elements.
AcoustoOpticalDevice_TypeVector	getAcoustoOpticalDeviceGroup_List() Returns the list of AcoustoOpticalDeviceGroup elements.
void	addToAcoustoOpticalDeviceGroup_List(AcoustoOpticalDevice_Type value) Adds a new AcoustoOpticalDeviceGroup element to this object.
void	clearAcoustoOpticalDeviceGroup_List() Clear the list of AcoustoOpticalDeviceGroup.
void	setElectroOpticalDeviceGroup_List(ElectroOpticalDevice_TypeVector value) Sets the list of ElectroOpticalDeviceGroup elements.
ElectroOpticalDevice_TypeVector	getElectroOpticalDeviceGroup_List() Returns the list of ElectroOpticalDeviceGroup elements.
void	addToElectroOpticalDeviceGroup_List(ElectroOpticalDevice_Type value) Adds a new ElectroOpticalDeviceGroup element to this object.
void	clearElectroOpticalDeviceGroup_List() Clear the list of ElectroOpticalDeviceGroup.
void	setMicrolensArray_List(MicrolensArrayVector value) Sets the list of MicrolensArray elements.
MicrolensArrayVector	getMicrolensArray_List() Returns the list of MicrolensArray elements.
void	addToMicrolensArray_List(MicrolensArray value) Adds a new MicrolensArray element to this object.
void	clearMicrolensArray_List() Clear the list of MicrolensArray.
void	setIntensityCalibrationTool_List(IntensityCalibrationToolVector value) Sets the list of IntensityCalibrationTool elements.
IntensityCalibrationToolVector	getIntensityCalibrationTool_List() Returns the list of IntensityCalibrationTool elements.
void	addToIntensityCalibrationTool_List(IntensityCalibrationTool value) Adds a new IntensityCalibrationTool element to this object.
void	clearIntensityCalibrationTool_List() Clear the list of IntensityCalibrationTool.
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.
Instrument	__internal_create(long cPtr, boolean own)

Protected Functions

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

Additional inherited members

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.Instrument;

Represents the XML element Instrument.

This element describes the Instrument used to capture the Image. It is primarily a container referring to the list of hardware components included in a given Microscope. The list consists of the Microscope Stand, Microscope Table, Light Source, Light Source Coupling, Sample Holder, Focusing, Objective, Filter, Dichroic, Additional Lens (including a commonly used Magnification Changer, also known as Optovar), Additional Mirroring Device, Polarization Optics, Prism, Optical Aperture, Optical Device, Detector and Calibration Tool. The Filter element can be either composed of separate Excitation, Emission filters, and Dichroic mirrors or a single Filter Set. An Instrument might have multiple Light Sources, Detectors, Objectives, and Filters, etc. Each of these has its own ID attribute, which can be referred to from the Image, Plane or more commonly Channel elements associated with a given Image Acquisition session. It is understood that the Light Path configuration can be different for each Channel, but cannot be different for each timepoint or each Plane of an XYZ stack.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function Instrument

public Instrument()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

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

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromMicroMetaAppJsonFile

public void fromMicroMetaAppJsonFile(
    String path
)

Populates this object from a JSON file generated by MicroMeta App.

Parameters:

path The path to the JSON file

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setID

public void setID(
    InstrumentID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

A Unique Identifier for this component.

function getID

public InstrumentID_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 setMicroscopeStandGroup_List

public void setMicroscopeStandGroup_List(
    MicroscopeStand_TypeVector value
)

Sets the list of MicroscopeStandGroup elements.

Parameters:

value The new list of MicroscopeStandGroup elements

No description available in the XSD standard.

function getMicroscopeStandGroup_List

public MicroscopeStand_TypeVector getMicroscopeStandGroup_List()

Returns the list of MicroscopeStandGroup elements.

Return: The list of MicroscopeStandGroup elements

No description available in the XSD standard.

function addToMicroscopeStandGroup_List

public void addToMicroscopeStandGroup_List(
    MicroscopeStand_Type value
)

Adds a new MicroscopeStandGroup element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearMicroscopeStandGroup_List

public void clearMicroscopeStandGroup_List()

Clear the list of MicroscopeStandGroup.

No description available in the XSD standard.

function setMicroscopeTable_List

public void setMicroscopeTable_List(
    MicroscopeTableVector value
)

Sets the list of MicroscopeTable elements.

Parameters:

value The new list of MicroscopeTable elements

No description available in the XSD standard.

function getMicroscopeTable_List

public MicroscopeTableVector getMicroscopeTable_List()

Returns the list of MicroscopeTable elements.

Return: The list of MicroscopeTable elements

No description available in the XSD standard.

function addToMicroscopeTable_List

public void addToMicroscopeTable_List(
    MicroscopeTable value
)

Adds a new MicroscopeTable element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearMicroscopeTable_List

public void clearMicroscopeTable_List()

Clear the list of MicroscopeTable.

No description available in the XSD standard.

function setSoftwareGroup_List

public void setSoftwareGroup_List(
    Software_TypeVector value
)

Sets the list of SoftwareGroup elements.

Parameters:

value The new list of SoftwareGroup elements

No description available in the XSD standard.

function getSoftwareGroup_List

public Software_TypeVector getSoftwareGroup_List()

Returns the list of SoftwareGroup elements.

Return: The list of SoftwareGroup elements

No description available in the XSD standard.

function addToSoftwareGroup_List

public void addToSoftwareGroup_List(
    Software_Type value
)

Adds a new SoftwareGroup element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearSoftwareGroup_List

public void clearSoftwareGroup_List()

Clear the list of SoftwareGroup.

No description available in the XSD standard.

function setEnvironmentalControlDevice_List

public void setEnvironmentalControlDevice_List(
    EnvironmentalControlDeviceVector value
)

Sets the list of EnvironmentalControlDevice elements.

Parameters:

value The new list of EnvironmentalControlDevice elements

No description available in the XSD standard.

function getEnvironmentalControlDevice_List

public EnvironmentalControlDeviceVector getEnvironmentalControlDevice_List()

Returns the list of EnvironmentalControlDevice elements.

Return: The list of EnvironmentalControlDevice elements

No description available in the XSD standard.

function addToEnvironmentalControlDevice_List

public void addToEnvironmentalControlDevice_List(
    EnvironmentalControlDevice value
)

Adds a new EnvironmentalControlDevice element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearEnvironmentalControlDevice_List

public void clearEnvironmentalControlDevice_List()

Clear the list of EnvironmentalControlDevice.

No description available in the XSD standard.

function setLightSourceGroup_List

public void setLightSourceGroup_List(
    LightSource_TypeVector value
)

Sets the list of LightSourceGroup elements.

Parameters:

value The new list of LightSourceGroup elements

This element describes the light source(s) available in this microscope

function getLightSourceGroup_List

public LightSource_TypeVector getLightSourceGroup_List()

Returns the list of LightSourceGroup elements.

Return: The list of LightSourceGroup elements

This element describes the light source(s) available in this microscope

function addToLightSourceGroup_List

public void addToLightSourceGroup_List(
    LightSource_Type value
)

Adds a new LightSourceGroup element to this object.

Parameters:

value The element to add

This element describes the light source(s) available in this microscope

function clearLightSourceGroup_List

public void clearLightSourceGroup_List()

Clear the list of LightSourceGroup.

This element describes the light source(s) available in this microscope

function setLightSourceCouplingGroup_List

public void setLightSourceCouplingGroup_List(
    LightSourceCoupling_TypeVector value
)

Sets the list of LightSourceCouplingGroup elements.

Parameters:

value The new list of LightSourceCouplingGroup elements

This element describes the method(s) used to couple the light source with the light path moving through speciment to the detector

function getLightSourceCouplingGroup_List

public LightSourceCoupling_TypeVector getLightSourceCouplingGroup_List()

Returns the list of LightSourceCouplingGroup elements.

Return: The list of LightSourceCouplingGroup elements

This element describes the method(s) used to couple the light source with the light path moving through speciment to the detector

function addToLightSourceCouplingGroup_List

public void addToLightSourceCouplingGroup_List(
    LightSourceCoupling_Type value
)

Adds a new LightSourceCouplingGroup element to this object.

Parameters:

value The element to add

This element describes the method(s) used to couple the light source with the light path moving through speciment to the detector

function clearLightSourceCouplingGroup_List

public void clearLightSourceCouplingGroup_List()

Clear the list of LightSourceCouplingGroup.

This element describes the method(s) used to couple the light source with the light path moving through speciment to the detector

function setObjective_List

public void setObjective_List(
    ObjectiveVector value
)

Sets the list of Objective elements.

Parameters:

value The new list of Objective elements

No description available in the XSD standard.

function getObjective_List

public ObjectiveVector getObjective_List()

Returns the list of Objective elements.

Return: The list of Objective elements

No description available in the XSD standard.

function addToObjective_List

public void addToObjective_List(
    Objective value
)

Adds a new Objective element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearObjective_List

public void clearObjective_List()

Clear the list of Objective.

No description available in the XSD standard.

function setOpticalAssemblyGroup_List

public void setOpticalAssemblyGroup_List(
    OpticalAssembly_TypeVector value
)

Sets the list of OpticalAssemblyGroup elements.

Parameters:

value The new list of OpticalAssemblyGroup elements

No description available in the XSD standard.

function getOpticalAssemblyGroup_List

public OpticalAssembly_TypeVector getOpticalAssemblyGroup_List()

Returns the list of OpticalAssemblyGroup elements.

Return: The list of OpticalAssemblyGroup elements

No description available in the XSD standard.

function addToOpticalAssemblyGroup_List

public void addToOpticalAssemblyGroup_List(
    OpticalAssembly_Type value
)

Adds a new OpticalAssemblyGroup element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearOpticalAssemblyGroup_List

public void clearOpticalAssemblyGroup_List()

Clear the list of OpticalAssemblyGroup.

No description available in the XSD standard.

function setOpticalApertureGroup_List

public void setOpticalApertureGroup_List(
    OpticalAperture_TypeVector value
)

Sets the list of OpticalApertureGroup elements.

Parameters:

value The new list of OpticalApertureGroup elements

No description available in the XSD standard.

function getOpticalApertureGroup_List

public OpticalAperture_TypeVector getOpticalApertureGroup_List()

Returns the list of OpticalApertureGroup elements.

Return: The list of OpticalApertureGroup elements

No description available in the XSD standard.

function addToOpticalApertureGroup_List

public void addToOpticalApertureGroup_List(
    OpticalAperture_Type value
)

Adds a new OpticalApertureGroup element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearOpticalApertureGroup_List

public void clearOpticalApertureGroup_List()

Clear the list of OpticalApertureGroup.

No description available in the XSD standard.

function setStageInsert_List

public void setStageInsert_List(
    StageInsertVector value
)

Sets the list of StageInsert elements.

Parameters:

value The new list of StageInsert elements

No description available in the XSD standard.

function getStageInsert_List

public StageInsertVector getStageInsert_List()

Returns the list of StageInsert elements.

Return: The list of StageInsert elements

No description available in the XSD standard.

function addToStageInsert_List

public void addToStageInsert_List(
    StageInsert value
)

Adds a new StageInsert element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearStageInsert_List

public void clearStageInsert_List()

Clear the list of StageInsert.

No description available in the XSD standard.

function setSamplePositioningGroup_List

public void setSamplePositioningGroup_List(
    SamplePositioning_TypeVector value
)

Sets the list of SamplePositioningGroup elements.

Parameters:

value The new list of SamplePositioningGroup elements

This element describes the objective lens and stage positioning device(s) available in this microscope. An Instrument may have more than one of these devices. The type of Focusing Device is specified by one of the child-element which are 'MechanicalStage', 'PiezoElectricSate', or 'PiezoElectricObjective'

function getSamplePositioningGroup_List

public SamplePositioning_TypeVector getSamplePositioningGroup_List()

Returns the list of SamplePositioningGroup elements.

Return: The list of SamplePositioningGroup elements

This element describes the objective lens and stage positioning device(s) available in this microscope. An Instrument may have more than one of these devices. The type of Focusing Device is specified by one of the child-element which are 'MechanicalStage', 'PiezoElectricSate', or 'PiezoElectricObjective'

function addToSamplePositioningGroup_List

public void addToSamplePositioningGroup_List(
    SamplePositioning_Type value
)

Adds a new SamplePositioningGroup element to this object.

Parameters:

value The element to add

This element describes the objective lens and stage positioning device(s) available in this microscope. An Instrument may have more than one of these devices. The type of Focusing Device is specified by one of the child-element which are 'MechanicalStage', 'PiezoElectricSate', or 'PiezoElectricObjective'

function clearSamplePositioningGroup_List

public void clearSamplePositioningGroup_List()

Clear the list of SamplePositioningGroup.

This element describes the objective lens and stage positioning device(s) available in this microscope. An Instrument may have more than one of these devices. The type of Focusing Device is specified by one of the child-element which are 'MechanicalStage', 'PiezoElectricSate', or 'PiezoElectricObjective'

function setFocusStabilizationDevice_List

public void setFocusStabilizationDevice_List(
    FocusStabilizationDeviceVector value
)

Sets the list of FocusStabilizationDevice elements.

Parameters:

value The new list of FocusStabilizationDevice elements

This element describes the focus stabilization device(s) available for this microscope

function getFocusStabilizationDevice_List

public FocusStabilizationDeviceVector getFocusStabilizationDevice_List()

Returns the list of FocusStabilizationDevice elements.

Return: The list of FocusStabilizationDevice elements

This element describes the focus stabilization device(s) available for this microscope

function addToFocusStabilizationDevice_List

public void addToFocusStabilizationDevice_List(
    FocusStabilizationDevice value
)

Adds a new FocusStabilizationDevice element to this object.

Parameters:

value The element to add

This element describes the focus stabilization device(s) available for this microscope

function clearFocusStabilizationDevice_List

public void clearFocusStabilizationDevice_List()

Clear the list of FocusStabilizationDevice.

This element describes the focus stabilization device(s) available for this microscope

function setOpticsHolderGroup_List

public void setOpticsHolderGroup_List(
    OpticsHolder_TypeVector value
)

Sets the list of OpticsHolderGroup elements.

Parameters:

value The new list of OpticsHolderGroup elements

No description available in the XSD standard.

function getOpticsHolderGroup_List

public OpticsHolder_TypeVector getOpticsHolderGroup_List()

Returns the list of OpticsHolderGroup elements.

Return: The list of OpticsHolderGroup elements

No description available in the XSD standard.

function addToOpticsHolderGroup_List

public void addToOpticsHolderGroup_List(
    OpticsHolder_Type value
)

Adds a new OpticsHolderGroup element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearOpticsHolderGroup_List

public void clearOpticsHolderGroup_List()

Clear the list of OpticsHolderGroup.

No description available in the XSD standard.

function setFilterGroup_List

public void setFilterGroup_List(
    Filter_TypeVector value
)

Sets the list of FilterGroup elements.

Parameters:

value The new list of FilterGroup elements

No description available in the XSD standard.

function getFilterGroup_List

public Filter_TypeVector getFilterGroup_List()

Returns the list of FilterGroup elements.

Return: The list of FilterGroup elements

No description available in the XSD standard.

function addToFilterGroup_List

public void addToFilterGroup_List(
    Filter_Type value
)

Adds a new FilterGroup element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearFilterGroup_List

public void clearFilterGroup_List()

Clear the list of FilterGroup.

No description available in the XSD standard.

function setMirroringDeviceGroup_List

public void setMirroringDeviceGroup_List(
    MirroringDevice_TypeVector value
)

Sets the list of MirroringDeviceGroup elements.

Parameters:

value The new list of MirroringDeviceGroup elements

This element describes mirror component(s) available in this microscope

function getMirroringDeviceGroup_List

public MirroringDevice_TypeVector getMirroringDeviceGroup_List()

Returns the list of MirroringDeviceGroup elements.

Return: The list of MirroringDeviceGroup elements

This element describes mirror component(s) available in this microscope

function addToMirroringDeviceGroup_List

public void addToMirroringDeviceGroup_List(
    MirroringDevice_Type value
)

Adds a new MirroringDeviceGroup element to this object.

Parameters:

value The element to add

This element describes mirror component(s) available in this microscope

function clearMirroringDeviceGroup_List

public void clearMirroringDeviceGroup_List()

Clear the list of MirroringDeviceGroup.

This element describes mirror component(s) available in this microscope

function setLensGroup_List

public void setLensGroup_List(
    Lens_TypeVector value
)

Sets the list of LensGroup elements.

Parameters:

value The new list of LensGroup elements

No description available in the XSD standard.

function getLensGroup_List

public Lens_TypeVector getLensGroup_List()

Returns the list of LensGroup elements.

Return: The list of LensGroup elements

No description available in the XSD standard.

function addToLensGroup_List

public void addToLensGroup_List(
    Lens_Type value
)

Adds a new LensGroup element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearLensGroup_List

public void clearLensGroup_List()

Clear the list of LensGroup.

No description available in the XSD standard.

function setPrism_List

public void setPrism_List(
    PrismVector value
)

Sets the list of Prism elements.

Parameters:

value The new list of Prism elements

No description available in the XSD standard.

function getPrism_List

public PrismVector getPrism_List()

Returns the list of Prism elements.

Return: The list of Prism elements

No description available in the XSD standard.

function addToPrism_List

public void addToPrism_List(
    Prism value
)

Adds a new Prism element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearPrism_List

public void clearPrism_List()

Clear the list of Prism.

No description available in the XSD standard.

function setPolarizationOptics_List

public void setPolarizationOptics_List(
    PolarizationOpticsVector value
)

Sets the list of PolarizationOptics elements.

Parameters:

value The new list of PolarizationOptics elements

No description available in the XSD standard.

function getPolarizationOptics_List

public PolarizationOpticsVector getPolarizationOptics_List()

Returns the list of PolarizationOptics elements.

Return: The list of PolarizationOptics elements

No description available in the XSD standard.

function addToPolarizationOptics_List

public void addToPolarizationOptics_List(
    PolarizationOptics value
)

Adds a new PolarizationOptics element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearPolarizationOptics_List

public void clearPolarizationOptics_List()

Clear the list of PolarizationOptics.

No description available in the XSD standard.

function setDetectorGroup_List

public void setDetectorGroup_List(
    Detector_TypeVector value
)

Sets the list of DetectorGroup elements.

Parameters:

value The new list of DetectorGroup elements

No description available in the XSD standard.

function getDetectorGroup_List

public Detector_TypeVector getDetectorGroup_List()

Returns the list of DetectorGroup elements.

Return: The list of DetectorGroup elements

No description available in the XSD standard.

function addToDetectorGroup_List

public void addToDetectorGroup_List(
    Detector_Type value
)

Adds a new DetectorGroup element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearDetectorGroup_List

public void clearDetectorGroup_List()

Clear the list of DetectorGroup.

No description available in the XSD standard.

function setTIRFHardwareModule_List

public void setTIRFHardwareModule_List(
    TIRFHardwareModuleVector value
)

Sets the list of TIRFHardwareModule elements.

Parameters:

value The new list of TIRFHardwareModule elements

No description available in the XSD standard.

function getTIRFHardwareModule_List

public TIRFHardwareModuleVector getTIRFHardwareModule_List()

Returns the list of TIRFHardwareModule elements.

Return: The list of TIRFHardwareModule elements

No description available in the XSD standard.

function addToTIRFHardwareModule_List

public void addToTIRFHardwareModule_List(
    TIRFHardwareModule value
)

Adds a new TIRFHardwareModule element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearTIRFHardwareModule_List

public void clearTIRFHardwareModule_List()

Clear the list of TIRFHardwareModule.

No description available in the XSD standard.

function setConfocalScannerGroup_List

public void setConfocalScannerGroup_List(
    ConfocalScanner_TypeVector value
)

Sets the list of ConfocalScannerGroup elements.

Parameters:

value The new list of ConfocalScannerGroup elements

No description available in the XSD standard.

function getConfocalScannerGroup_List

public ConfocalScanner_TypeVector getConfocalScannerGroup_List()

Returns the list of ConfocalScannerGroup elements.

Return: The list of ConfocalScannerGroup elements

No description available in the XSD standard.

function addToConfocalScannerGroup_List

public void addToConfocalScannerGroup_List(
    ConfocalScanner_Type value
)

Adds a new ConfocalScannerGroup element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearConfocalScannerGroup_List

public void clearConfocalScannerGroup_List()

Clear the list of ConfocalScannerGroup.

No description available in the XSD standard.

function setAcoustoOpticalDeviceGroup_List

public void setAcoustoOpticalDeviceGroup_List(
    AcoustoOpticalDevice_TypeVector value
)

Sets the list of AcoustoOpticalDeviceGroup elements.

Parameters:

value The new list of AcoustoOpticalDeviceGroup elements

No description available in the XSD standard.

function getAcoustoOpticalDeviceGroup_List

public AcoustoOpticalDevice_TypeVector getAcoustoOpticalDeviceGroup_List()

Returns the list of AcoustoOpticalDeviceGroup elements.

Return: The list of AcoustoOpticalDeviceGroup elements

No description available in the XSD standard.

function addToAcoustoOpticalDeviceGroup_List

public void addToAcoustoOpticalDeviceGroup_List(
    AcoustoOpticalDevice_Type value
)

Adds a new AcoustoOpticalDeviceGroup element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearAcoustoOpticalDeviceGroup_List

public void clearAcoustoOpticalDeviceGroup_List()

Clear the list of AcoustoOpticalDeviceGroup.

No description available in the XSD standard.

function setElectroOpticalDeviceGroup_List

public void setElectroOpticalDeviceGroup_List(
    ElectroOpticalDevice_TypeVector value
)

Sets the list of ElectroOpticalDeviceGroup elements.

Parameters:

value The new list of ElectroOpticalDeviceGroup elements

No description available in the XSD standard.

function getElectroOpticalDeviceGroup_List

public ElectroOpticalDevice_TypeVector getElectroOpticalDeviceGroup_List()

Returns the list of ElectroOpticalDeviceGroup elements.

Return: The list of ElectroOpticalDeviceGroup elements

No description available in the XSD standard.

function addToElectroOpticalDeviceGroup_List

public void addToElectroOpticalDeviceGroup_List(
    ElectroOpticalDevice_Type value
)

Adds a new ElectroOpticalDeviceGroup element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearElectroOpticalDeviceGroup_List

public void clearElectroOpticalDeviceGroup_List()

Clear the list of ElectroOpticalDeviceGroup.

No description available in the XSD standard.

function setMicrolensArray_List

public void setMicrolensArray_List(
    MicrolensArrayVector value
)

Sets the list of MicrolensArray elements.

Parameters:

value The new list of MicrolensArray elements

No description available in the XSD standard.

function getMicrolensArray_List

public MicrolensArrayVector getMicrolensArray_List()

Returns the list of MicrolensArray elements.

Return: The list of MicrolensArray elements

No description available in the XSD standard.

function addToMicrolensArray_List

public void addToMicrolensArray_List(
    MicrolensArray value
)

Adds a new MicrolensArray element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearMicrolensArray_List

public void clearMicrolensArray_List()

Clear the list of MicrolensArray.

No description available in the XSD standard.

function setIntensityCalibrationTool_List

public void setIntensityCalibrationTool_List(
    IntensityCalibrationToolVector value
)

Sets the list of IntensityCalibrationTool elements.

Parameters:

value The new list of IntensityCalibrationTool elements

No description available in the XSD standard.

function getIntensityCalibrationTool_List

public IntensityCalibrationToolVector getIntensityCalibrationTool_List()

Returns the list of IntensityCalibrationTool elements.

Return: The list of IntensityCalibrationTool elements

No description available in the XSD standard.

function addToIntensityCalibrationTool_List

public void addToIntensityCalibrationTool_List(
    IntensityCalibrationTool value
)

Adds a new IntensityCalibrationTool element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearIntensityCalibrationTool_List

public void clearIntensityCalibrationTool_List()

Clear the list of IntensityCalibrationTool.

No description available in the XSD standard.

function setAnnotationRef

public void setAnnotationRef(
    AnnotationRef value
)

Sets the value of the AnnotationRef element.

Parameters:

value The value to set

This is a simple multi-line comment or annotation describing this component.

function getAnnotationRef

public AnnotationRef getAnnotationRef()

Returns the value of the AnnotationRef element.

Return: The value of the element

This is a simple multi-line comment or annotation describing this component.

function resetAnnotationRef

public void resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

This is a simple multi-line comment or annotation describing this component.

function hasAnnotationRef

public boolean hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

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

This is a simple multi-line comment or annotation describing this component.

function __internal_create

public static Instrument __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

Protected Functions Documentation

function Instrument

protected Instrument(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr

protected static long getCPtr(
    Instrument obj
)

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