com.inscoper.nbo.IndividualObjectiveFocusing¶

Represents the XML element IndividualObjectiveFocusing. More...

Inherits from com.inscoper.nbo.FocusingDevice_Type, com.inscoper.nbo.SamplePositioning_Type, com.inscoper.nbo.ManufacturerSpec_Type, com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	IndividualObjectiveFocusing()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setPiezoElectric(boolean value, boolean validate) Sets the value of the PiezoElectric attribute.
void	setPiezoElectric(boolean value) Sets the value of the PiezoElectric attribute.
boolean	getPiezoElectric() Returns the value of the PiezoElectric attribute.
void	resetPiezoElectric() Resets the PiezoElectric attribute to an unset state.
boolean	hasPiezoElectric() Checks whether the PiezoElectric attribute is present.
IndividualObjectiveFocusing	__internal_create(long cPtr, boolean own)
IndividualObjectiveFocusing	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a IndividualObjectiveFocusing.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.FocusingDevice_Type

	Name
	FocusingDevice_Type()

Protected Functions inherited from com.inscoper.nbo.FocusingDevice_Type

	Name
	FocusingDevice_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.SamplePositioning_Type

	Name
	SamplePositioning_Type()
void	setID(SamplePositioningID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(SamplePositioningID_Type value) Sets the value of the ID attribute.
SamplePositioningID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value, boolean validate) Sets the value of the Name attribute.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setEncoded(Encoded_Type value, boolean validate) Sets the value of the Encoded attribute.
void	setEncoded(Encoded_Type value) Sets the value of the Encoded attribute.
Encoded_Type	getEncoded() Returns the value of the Encoded attribute.
void	resetEncoded() Resets the Encoded attribute to an unset state.
boolean	hasEncoded() Checks whether the optional Encoded attribute is present.
void	setMotorized(boolean value, boolean validate) Sets the value of the Motorized attribute.
void	setMotorized(boolean value) Sets the value of the Motorized attribute.
boolean	getMotorized() Returns the value of the Motorized attribute.
void	resetMotorized() Resets the Motorized attribute to an unset state.
boolean	hasMotorized() Checks whether the Motorized attribute is present.
void	setZMaxVelocity(float value, boolean validate) Sets the value of the ZMaxVelocity attribute.
void	setZMaxVelocity(float value) Sets the value of the ZMaxVelocity attribute.
float	getZMaxVelocity() Returns the value of the ZMaxVelocity attribute.
void	resetZMaxVelocity() Resets the ZMaxVelocity attribute to an unset state.
boolean	hasZMaxVelocity() Checks whether the ZMaxVelocity attribute is present.
void	setZMaxVelocityUnit(UnitsVelocity_Type value, boolean validate) Sets the value of the ZMaxVelocityUnit attribute.
void	setZMaxVelocityUnit(UnitsVelocity_Type value) Sets the value of the ZMaxVelocityUnit attribute.
UnitsVelocity_Type	getZMaxVelocityUnit() Returns the value of the ZMaxVelocityUnit attribute.
void	resetZMaxVelocityUnit() Resets the ZMaxVelocityUnit attribute to an unset state.
boolean	hasZMaxVelocityUnit() Checks whether the optional ZMaxVelocityUnit attribute is present.
void	setZRepeatability(float value, boolean validate) Sets the value of the ZRepeatability attribute.
void	setZRepeatability(float value) Sets the value of the ZRepeatability attribute.
float	getZRepeatability() Returns the value of the ZRepeatability attribute.
void	resetZRepeatability() Resets the ZRepeatability attribute to an unset state.
boolean	hasZRepeatability() Checks whether the ZRepeatability attribute is present.
void	setZRepeatabilityUnit(UnitsLength_Type value, boolean validate) Sets the value of the ZRepeatabilityUnit attribute.
void	setZRepeatabilityUnit(UnitsLength_Type value) Sets the value of the ZRepeatabilityUnit attribute.
UnitsLength_Type	getZRepeatabilityUnit() Returns the value of the ZRepeatabilityUnit attribute.
void	resetZRepeatabilityUnit() Resets the ZRepeatabilityUnit attribute to an unset state.
boolean	hasZRepeatabilityUnit() Checks whether the optional ZRepeatabilityUnit attribute is present.
void	setZTravelRange(float value, boolean validate) Sets the value of the ZTravelRange attribute.
void	setZTravelRange(float value) Sets the value of the ZTravelRange attribute.
float	getZTravelRange() Returns the value of the ZTravelRange attribute.
void	resetZTravelRange() Resets the ZTravelRange attribute to an unset state.
boolean	hasZTravelRange() Checks whether the ZTravelRange attribute is present.
void	setZTravelRangeUnit(UnitsLength_Type value, boolean validate) Sets the value of the ZTravelRangeUnit attribute.
void	setZTravelRangeUnit(UnitsLength_Type value) Sets the value of the ZTravelRangeUnit attribute.
UnitsLength_Type	getZTravelRangeUnit() Returns the value of the ZTravelRangeUnit attribute.
void	resetZTravelRangeUnit() Resets the ZTravelRangeUnit attribute to an unset state.
boolean	hasZTravelRangeUnit() Checks whether the optional ZTravelRangeUnit attribute is present.
void	setMovementAxes(StageMovementAxes_Type value, boolean validate) Sets the value of the MovementAxes attribute.
void	setMovementAxes(StageMovementAxes_Type value) Sets the value of the MovementAxes attribute.
StageMovementAxes_Type	getMovementAxes() Returns the value of the MovementAxes attribute.
void	resetMovementAxes() Resets the MovementAxes attribute to an unset state.
boolean	hasMovementAxes() Checks whether the optional MovementAxes attribute is present.
void	setBuiltIn(boolean value, boolean validate) Sets the value of the BuiltIn attribute.
void	setBuiltIn(boolean value) Sets the value of the BuiltIn attribute.
boolean	getBuiltIn() Returns the value of the BuiltIn attribute.
void	resetBuiltIn() Resets the BuiltIn attribute to an unset state.
boolean	hasBuiltIn() Checks whether the BuiltIn attribute is present.
void	setZReproducibility(float value, boolean validate) Sets the value of the ZReproducibility attribute.
void	setZReproducibility(float value) Sets the value of the ZReproducibility attribute.
float	getZReproducibility() Returns the value of the ZReproducibility attribute.
void	resetZReproducibility() Resets the ZReproducibility attribute to an unset state.
boolean	hasZReproducibility() Checks whether the ZReproducibility attribute is present.
void	setZReproducibilityUnit(UnitsLength_Type value, boolean validate) Sets the value of the ZReproducibilityUnit attribute.
void	setZReproducibilityUnit(UnitsLength_Type value) Sets the value of the ZReproducibilityUnit attribute.
UnitsLength_Type	getZReproducibilityUnit() Returns the value of the ZReproducibilityUnit attribute.
void	resetZReproducibilityUnit() Resets the ZReproducibilityUnit attribute to an unset state.
boolean	hasZReproducibilityUnit() Checks whether the optional ZReproducibilityUnit attribute is present.
void	setZSettlingTime(float value, boolean validate) Sets the value of the ZSettlingTime attribute.
void	setZSettlingTime(float value) Sets the value of the ZSettlingTime attribute.
float	getZSettlingTime() Returns the value of the ZSettlingTime attribute.
void	resetZSettlingTime() Resets the ZSettlingTime attribute to an unset state.
boolean	hasZSettlingTime() Checks whether the ZSettlingTime attribute is present.
void	setZSettlingTimeUnit(UnitsTime_Type value, boolean validate) Sets the value of the ZSettlingTimeUnit attribute.
void	setZSettlingTimeUnit(UnitsTime_Type value) Sets the value of the ZSettlingTimeUnit attribute.
UnitsTime_Type	getZSettlingTimeUnit() Returns the value of the ZSettlingTimeUnit attribute.
void	resetZSettlingTimeUnit() Resets the ZSettlingTimeUnit attribute to an unset state.
boolean	hasZSettlingTimeUnit() Checks whether the optional ZSettlingTimeUnit attribute is present.
void	setZResolution(float value, boolean validate) Sets the value of the ZResolution attribute.
void	setZResolution(float value) Sets the value of the ZResolution attribute.
float	getZResolution() Returns the value of the ZResolution attribute.
void	resetZResolution() Resets the ZResolution attribute to an unset state.
boolean	hasZResolution() Checks whether the ZResolution attribute is present.
void	setZResolutionUnit(UnitsLength_Type value, boolean validate) Sets the value of the ZResolutionUnit attribute.
void	setZResolutionUnit(UnitsLength_Type value) Sets the value of the ZResolutionUnit attribute.
UnitsLength_Type	getZResolutionUnit() Returns the value of the ZResolutionUnit attribute.
void	resetZResolutionUnit() Resets the ZResolutionUnit attribute to an unset state.
boolean	hasZResolutionUnit() Checks whether the optional ZResolutionUnit attribute is present.
void	setZPositionLinearityError(float value, boolean validate) Sets the value of the ZPositionLinearityError attribute.
void	setZPositionLinearityError(float value) Sets the value of the ZPositionLinearityError attribute.
float	getZPositionLinearityError() Returns the value of the ZPositionLinearityError attribute.
void	resetZPositionLinearityError() Resets the ZPositionLinearityError attribute to an unset state.
boolean	hasZPositionLinearityError() Checks whether the ZPositionLinearityError attribute is present.
void	setType(PositioningType_Type value, boolean validate) Sets the value of the Type attribute.
void	setType(PositioningType_Type value) Sets the value of the Type attribute.
PositioningType_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	setRotationAngle(float value, boolean validate) Sets the value of the RotationAngle attribute.
void	setRotationAngle(float value) Sets the value of the RotationAngle attribute.
float	getRotationAngle() Returns the value of the RotationAngle attribute.
void	resetRotationAngle() Resets the RotationAngle attribute to an unset state.
boolean	hasRotationAngle() Checks whether the RotationAngle attribute is present.
void	setRotationAngleUnit(UnitsAngle_Type value, boolean validate) Sets the value of the RotationAngleUnit attribute.
void	setRotationAngleUnit(UnitsAngle_Type value) Sets the value of the RotationAngleUnit attribute.
UnitsAngle_Type	getRotationAngleUnit() Returns the value of the RotationAngleUnit attribute.
void	resetRotationAngleUnit() Resets the RotationAngleUnit attribute to an unset state.
boolean	hasRotationAngleUnit() Checks whether the optional RotationAngleUnit attribute is present.
void	setAnnotationRef(AnnotationRef value, boolean validate) Sets the value of the AnnotationRef element.
void	setAnnotationRef(AnnotationRef value) Sets the value of the AnnotationRef element.
AnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.

Protected Functions inherited from com.inscoper.nbo.SamplePositioning_Type

	Name
	SamplePositioning_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
void	setManufacturer(String value, boolean validate) Sets the value of the Manufacturer attribute.
void	setManufacturer(String value) Sets the value of the Manufacturer attribute.
String	getManufacturer() Returns the value of the Manufacturer attribute.
void	resetManufacturer() Resets the Manufacturer attribute to an unset state.
boolean	hasManufacturer() Checks whether the Manufacturer attribute is present.
void	setModel(String value, boolean validate) Sets the value of the Model attribute.
void	setModel(String value) Sets the value of the Model attribute.
String	getModel() Returns the value of the Model attribute.
void	resetModel() Resets the Model attribute to an unset state.
boolean	hasModel() Checks whether the Model attribute is present.
void	setCatalogNumber(String value, boolean validate) Sets the value of the CatalogNumber attribute.
void	setCatalogNumber(String value) Sets the value of the CatalogNumber attribute.
String	getCatalogNumber() Returns the value of the CatalogNumber attribute.
void	resetCatalogNumber() Resets the CatalogNumber attribute to an unset state.
boolean	hasCatalogNumber() Checks whether the CatalogNumber attribute is present.
void	setLotNumber(String value, boolean validate) Sets the value of the LotNumber attribute.
void	setLotNumber(String value) Sets the value of the LotNumber attribute.
String	getLotNumber() Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
boolean	hasLotNumber() Checks whether the LotNumber attribute is present.
void	setMapAnnotation_List(MapAnnotationVector value, boolean validate) Sets the list of MapAnnotation elements.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value, boolean validate) Adds a new MapAnnotation element to this object.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(FileAnnotation_Type value, boolean validate) Sets the value of the SpecsFile element.
void	setSpecsFile(FileAnnotation_Type value) Sets the value of the SpecsFile element.
FileAnnotation_Type	getSpecsFile() Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
boolean	hasSpecsFile() Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value, boolean validate) Sets the list of AdditionalVendorInformation elements.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value, boolean validate) Adds a new AdditionalVendorInformation element to this object.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.
StringSet	getManufacturerAllowedValues() Returns the allowed values for this attribut.
StringSet	getModelAllowedValues() Returns the allowed values for this attribut.
StringSet	getCatalogNumberAllowedValues() Returns the allowed values for this attribut.
StringSet	getLotNumberAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.IndividualObjectiveFocusing;

Represents the XML element IndividualObjectiveFocusing.

A Focusing mechanism is used to obtain maximum sharpness in an Image by changing the distance between a Sample and the optical system forming the Image. In most cases, a Z-axis Focusing mechanism moves the Objective along the optical axis. This element describes an optional objective nano-Focusing Device associated with this Instrument. These devices might be driven using piezoelectric mechanisms or linear motor actuators associated with crossed roller guideways. They typically achieve higher precision, accuracy, and speed than traditional Focusing Devices.

Public Functions Documentation¶

function delete¶

function IndividualObjectiveFocusing¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function 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.FocusingDevice_Type.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.FocusingDevice_Type.fromJsonFile

function fromJsonFile¶

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.FocusingDevice_Type.fromJsonString

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.FocusingDevice_Type.fromJsonString

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.FocusingDevice_Type.fromXmlFile

function fromXmlFile¶

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.FocusingDevice_Type.fromXmlString

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.FocusingDevice_Type.fromXmlString

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.FocusingDevice_Type.toXmlFile

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.FocusingDevice_Type.toXmlFile

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.FocusingDevice_Type.toXmlString

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.FocusingDevice_Type.toXmlString

function setPiezoElectric¶

public void setPiezoElectric(
    boolean value,
    boolean validate
)

Sets the value of the PiezoElectric attribute.

Parameters:

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

This field describes whether this device is Piezoelectric driven (True) or not (False).

function setPiezoElectric¶

public void setPiezoElectric(
    boolean value
)

Sets the value of the PiezoElectric attribute.

Parameters:

value The value to set

This field describes whether this device is Piezoelectric driven (True) or not (False).

function getPiezoElectric¶

public boolean getPiezoElectric()

Returns the value of the PiezoElectric attribute.

Return: The value of the attribute

This field describes whether this device is Piezoelectric driven (True) or not (False).

function resetPiezoElectric¶

function hasPiezoElectric¶

public boolean hasPiezoElectric()

Checks whether the PiezoElectric attribute is present.

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

This field describes whether this device is Piezoelectric driven (True) or not (False).

function __internal_create¶

function fromBase¶

public static IndividualObjectiveFocusing fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a IndividualObjectiveFocusing.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.FocusingDevice_Type.fromBase

com.inscoper.nbo.IndividualObjectiveFocusing¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function IndividualObjectiveFocusing¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

function fromJsonFile¶

function fromJsonString¶

function fromJsonString¶

function fromXmlFile¶

function fromXmlFile¶

function fromXmlString¶

function fromXmlString¶

function toXmlFile¶

function toXmlFile¶

function toXmlString¶

function toXmlString¶

function setPiezoElectric¶

function setPiezoElectric¶

function getPiezoElectric¶

function resetPiezoElectric¶

function hasPiezoElectric¶

function __internal_create¶

function fromBase¶

Protected Functions Documentation¶

function IndividualObjectiveFocusing¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶