com.inscoper.nbo.Stage_Type¶

Represents the XML complex type Stage. More...

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

Inherited by com.inscoper.nbo.MechanicalStage, com.inscoper.nbo.PiezoElectricStage

Public Functions¶

	Name
synchronized void	delete()
	Stage_Type()
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	setXYMaxVelocity(float value, boolean validate) Sets the value of the XYMaxVelocity attribute.
void	setXYMaxVelocity(float value) Sets the value of the XYMaxVelocity attribute.
float	getXYMaxVelocity() Returns the value of the XYMaxVelocity attribute.
void	resetXYMaxVelocity() Resets the XYMaxVelocity attribute to an unset state.
boolean	hasXYMaxVelocity() Checks whether the XYMaxVelocity attribute is present.
void	setXYMaxVelocityUnit(UnitsVelocity_Type value, boolean validate) Sets the value of the XYMaxVelocityUnit attribute.
void	setXYMaxVelocityUnit(UnitsVelocity_Type value) Sets the value of the XYMaxVelocityUnit attribute.
UnitsVelocity_Type	getXYMaxVelocityUnit() Returns the value of the XYMaxVelocityUnit attribute.
void	resetXYMaxVelocityUnit() Resets the XYMaxVelocityUnit attribute to an unset state.
boolean	hasXYMaxVelocityUnit() Checks whether the optional XYMaxVelocityUnit attribute is present.
void	setXYRepeatability(float value, boolean validate) Sets the value of the XYRepeatability attribute.
void	setXYRepeatability(float value) Sets the value of the XYRepeatability attribute.
float	getXYRepeatability() Returns the value of the XYRepeatability attribute.
void	resetXYRepeatability() Resets the XYRepeatability attribute to an unset state.
boolean	hasXYRepeatability() Checks whether the XYRepeatability attribute is present.
void	setXYRepeatabilityUnit(UnitsLength_Type value, boolean validate) Sets the value of the XYRepeatabilityUnit attribute.
void	setXYRepeatabilityUnit(UnitsLength_Type value) Sets the value of the XYRepeatabilityUnit attribute.
UnitsLength_Type	getXYRepeatabilityUnit() Returns the value of the XYRepeatabilityUnit attribute.
void	resetXYRepeatabilityUnit() Resets the XYRepeatabilityUnit attribute to an unset state.
boolean	hasXYRepeatabilityUnit() Checks whether the optional XYRepeatabilityUnit attribute is present.
void	setXTravelRange(float value, boolean validate) Sets the value of the XTravelRange attribute.
void	setXTravelRange(float value) Sets the value of the XTravelRange attribute.
float	getXTravelRange() Returns the value of the XTravelRange attribute.
void	resetXTravelRange() Resets the XTravelRange attribute to an unset state.
boolean	hasXTravelRange() Checks whether the XTravelRange attribute is present.
void	setXTravelRangeUnit(UnitsLength_Type value, boolean validate) Sets the value of the XTravelRangeUnit attribute.
void	setXTravelRangeUnit(UnitsLength_Type value) Sets the value of the XTravelRangeUnit attribute.
UnitsLength_Type	getXTravelRangeUnit() Returns the value of the XTravelRangeUnit attribute.
void	resetXTravelRangeUnit() Resets the XTravelRangeUnit attribute to an unset state.
boolean	hasXTravelRangeUnit() Checks whether the optional XTravelRangeUnit attribute is present.
void	setYTravelRange(float value, boolean validate) Sets the value of the YTravelRange attribute.
void	setYTravelRange(float value) Sets the value of the YTravelRange attribute.
float	getYTravelRange() Returns the value of the YTravelRange attribute.
void	resetYTravelRange() Resets the YTravelRange attribute to an unset state.
boolean	hasYTravelRange() Checks whether the YTravelRange attribute is present.
void	setYTravelRangeUnit(UnitsLength_Type value, boolean validate) Sets the value of the YTravelRangeUnit attribute.
void	setYTravelRangeUnit(UnitsLength_Type value) Sets the value of the YTravelRangeUnit attribute.
UnitsLength_Type	getYTravelRangeUnit() Returns the value of the YTravelRangeUnit attribute.
void	resetYTravelRangeUnit() Resets the YTravelRangeUnit attribute to an unset state.
boolean	hasYTravelRangeUnit() Checks whether the optional YTravelRangeUnit attribute is present.
void	setXYReproducibility(float value, boolean validate) Sets the value of the XYReproducibility attribute.
void	setXYReproducibility(float value) Sets the value of the XYReproducibility attribute.
float	getXYReproducibility() Returns the value of the XYReproducibility attribute.
void	resetXYReproducibility() Resets the XYReproducibility attribute to an unset state.
boolean	hasXYReproducibility() Checks whether the XYReproducibility attribute is present.
void	setXYReproducibilityUnit(UnitsLength_Type value, boolean validate) Sets the value of the XYReproducibilityUnit attribute.
void	setXYReproducibilityUnit(UnitsLength_Type value) Sets the value of the XYReproducibilityUnit attribute.
UnitsLength_Type	getXYReproducibilityUnit() Returns the value of the XYReproducibilityUnit attribute.
void	resetXYReproducibilityUnit() Resets the XYReproducibilityUnit attribute to an unset state.
boolean	hasXYReproducibilityUnit() Checks whether the optional XYReproducibilityUnit attribute is present.
void	setXYSettlingTime(float value, boolean validate) Sets the value of the XYSettlingTime attribute.
void	setXYSettlingTime(float value) Sets the value of the XYSettlingTime attribute.
float	getXYSettlingTime() Returns the value of the XYSettlingTime attribute.
void	resetXYSettlingTime() Resets the XYSettlingTime attribute to an unset state.
boolean	hasXYSettlingTime() Checks whether the XYSettlingTime attribute is present.
void	setXYSettlingTimeUnit(UnitsTime_Type value, boolean validate) Sets the value of the XYSettlingTimeUnit attribute.
void	setXYSettlingTimeUnit(UnitsTime_Type value) Sets the value of the XYSettlingTimeUnit attribute.
UnitsTime_Type	getXYSettlingTimeUnit() Returns the value of the XYSettlingTimeUnit attribute.
void	resetXYSettlingTimeUnit() Resets the XYSettlingTimeUnit attribute to an unset state.
boolean	hasXYSettlingTimeUnit() Checks whether the optional XYSettlingTimeUnit attribute is present.
void	setXYResolution(float value, boolean validate) Sets the value of the XYResolution attribute.
void	setXYResolution(float value) Sets the value of the XYResolution attribute.
float	getXYResolution() Returns the value of the XYResolution attribute.
void	resetXYResolution() Resets the XYResolution attribute to an unset state.
boolean	hasXYResolution() Checks whether the XYResolution attribute is present.
void	setXYZResolutionUnit(UnitsLength_Type value, boolean validate) Sets the value of the XYZResolutionUnit attribute.
void	setXYZResolutionUnit(UnitsLength_Type value) Sets the value of the XYZResolutionUnit attribute.
UnitsLength_Type	getXYZResolutionUnit() Returns the value of the XYZResolutionUnit attribute.
void	resetXYZResolutionUnit() Resets the XYZResolutionUnit attribute to an unset state.
boolean	hasXYZResolutionUnit() Checks whether the optional XYZResolutionUnit attribute is present.
void	setXYPositionLinearityError(float value, boolean validate) Sets the value of the XYPositionLinearityError attribute.
void	setXYPositionLinearityError(float value) Sets the value of the XYPositionLinearityError attribute.
float	getXYPositionLinearityError() Returns the value of the XYPositionLinearityError attribute.
void	resetXYPositionLinearityError() Resets the XYPositionLinearityError attribute to an unset state.
boolean	hasXYPositionLinearityError() Checks whether the XYPositionLinearityError attribute is present.
Stage_Type	__internal_create(long cPtr, boolean own)
Stage_Type	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a Stage_Type.

Protected Functions¶

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

Additional inherited members¶

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.Stage_Type;

Represents the XML complex type Stage.

This element describes a platform positioned at right angle to the optical axis of this Microscope, which is designed to either directly hold a Specimen Holder containing a Sample to be observed, or a Stage Insert, which itself holds the Sample Holder. In many cases, this device is capable of mechanical movements (as in a Mechanical Stage) to allow easy positioning and rotation of the Sample in the X-, Y-, and Z-axes.

Public Functions Documentation¶

function delete¶

function Stage_Type¶

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.SamplePositioning_Type.getTypeName

Reimplemented by: com.inscoper.nbo.MechanicalStage.getTypeName, com.inscoper.nbo.PiezoElectricStage.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.SamplePositioning_Type.getXMLName

Reimplemented by: com.inscoper.nbo.MechanicalStage.getXMLName, com.inscoper.nbo.PiezoElectricStage.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.SamplePositioning_Type.getNBOType

Reimplemented by: com.inscoper.nbo.MechanicalStage.getNBOType, com.inscoper.nbo.PiezoElectricStage.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.SamplePositioning_Type.getChildren

Reimplemented by: com.inscoper.nbo.MechanicalStage.getChildren, com.inscoper.nbo.PiezoElectricStage.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.SamplePositioning_Type.getSubElements

Reimplemented by: com.inscoper.nbo.MechanicalStage.getSubElements, com.inscoper.nbo.PiezoElectricStage.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.SamplePositioning_Type.fromJsonFile

Reimplemented by: com.inscoper.nbo.MechanicalStage.fromJsonFile, com.inscoper.nbo.PiezoElectricStage.fromJsonFile

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.SamplePositioning_Type.fromJsonFile

Reimplemented by: com.inscoper.nbo.MechanicalStage.fromJsonFile, com.inscoper.nbo.PiezoElectricStage.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.SamplePositioning_Type.fromJsonString

Reimplemented by: com.inscoper.nbo.MechanicalStage.fromJsonString, com.inscoper.nbo.PiezoElectricStage.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.SamplePositioning_Type.fromJsonString

Reimplemented by: com.inscoper.nbo.MechanicalStage.fromJsonString, com.inscoper.nbo.PiezoElectricStage.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.SamplePositioning_Type.fromXmlFile

Reimplemented by: com.inscoper.nbo.MechanicalStage.fromXmlFile, com.inscoper.nbo.PiezoElectricStage.fromXmlFile

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.SamplePositioning_Type.fromXmlFile

Reimplemented by: com.inscoper.nbo.MechanicalStage.fromXmlFile, com.inscoper.nbo.PiezoElectricStage.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.SamplePositioning_Type.fromXmlString

Reimplemented by: com.inscoper.nbo.MechanicalStage.fromXmlString, com.inscoper.nbo.PiezoElectricStage.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.SamplePositioning_Type.fromXmlString

Reimplemented by: com.inscoper.nbo.MechanicalStage.fromXmlString, com.inscoper.nbo.PiezoElectricStage.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.SamplePositioning_Type.toXmlFile

Reimplemented by: com.inscoper.nbo.MechanicalStage.toXmlFile, com.inscoper.nbo.PiezoElectricStage.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.SamplePositioning_Type.toXmlFile

Reimplemented by: com.inscoper.nbo.MechanicalStage.toXmlFile, com.inscoper.nbo.PiezoElectricStage.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.SamplePositioning_Type.toXmlString

Reimplemented by: com.inscoper.nbo.MechanicalStage.toXmlString, com.inscoper.nbo.PiezoElectricStage.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.SamplePositioning_Type.toXmlString

Reimplemented by: com.inscoper.nbo.MechanicalStage.toXmlString, com.inscoper.nbo.PiezoElectricStage.toXmlString

function setXYMaxVelocity¶

public void setXYMaxVelocity(
    float value,
    boolean validate
)

Sets the value of the XYMaxVelocity attribute.

Parameters:

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

This field describes the maximum XY-axis Velocity at which this Stage is capable of moving.

function setXYMaxVelocity¶

public void setXYMaxVelocity(
    float value
)

Sets the value of the XYMaxVelocity attribute.

Parameters:

value The value to set

This field describes the maximum XY-axis Velocity at which this Stage is capable of moving.

function getXYMaxVelocity¶

public float getXYMaxVelocity()

Returns the value of the XYMaxVelocity attribute.

Return: The value of the attribute

This field describes the maximum XY-axis Velocity at which this Stage is capable of moving.

function resetXYMaxVelocity¶

function hasXYMaxVelocity¶

public boolean hasXYMaxVelocity()

Checks whether the XYMaxVelocity attribute is present.

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

This field describes the maximum XY-axis Velocity at which this Stage is capable of moving.

function setXYMaxVelocityUnit¶

public void setXYMaxVelocityUnit(
    UnitsVelocity_Type value,
    boolean validate
)

Sets the value of the XYMaxVelocityUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setXYMaxVelocityUnit¶

public void setXYMaxVelocityUnit(
    UnitsVelocity_Type value
)

Sets the value of the XYMaxVelocityUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getXYMaxVelocityUnit¶

function resetXYMaxVelocityUnit¶

function hasXYMaxVelocityUnit¶

public boolean hasXYMaxVelocityUnit()

Checks whether the optional XYMaxVelocityUnit attribute is present.

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

No description available in the XSD standard.

function setXYRepeatability¶

public void setXYRepeatability(
    float value,
    boolean validate
)

Sets the value of the XYRepeatability attribute.

Parameters:

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

This field captures the expected Accuracy with which this Stage is capable of returning to a previously visited XY-plane Position, as specified by the Manufacturer. This metric is important for example for Tiling.

function setXYRepeatability¶

public void setXYRepeatability(
    float value
)

Sets the value of the XYRepeatability attribute.

Parameters:

value The value to set

This field captures the expected Accuracy with which this Stage is capable of returning to a previously visited XY-plane Position, as specified by the Manufacturer. This metric is important for example for Tiling.

function getXYRepeatability¶

public float getXYRepeatability()

Returns the value of the XYRepeatability attribute.

Return: The value of the attribute

This field captures the expected Accuracy with which this Stage is capable of returning to a previously visited XY-plane Position, as specified by the Manufacturer. This metric is important for example for Tiling.

function resetXYRepeatability¶

public void resetXYRepeatability()

Resets the XYRepeatability attribute to an unset state.

This field captures the expected Accuracy with which this Stage is capable of returning to a previously visited XY-plane Position, as specified by the Manufacturer. This metric is important for example for Tiling.

function hasXYRepeatability¶

public boolean hasXYRepeatability()

Checks whether the XYRepeatability attribute is present.

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

This field captures the expected Accuracy with which this Stage is capable of returning to a previously visited XY-plane Position, as specified by the Manufacturer. This metric is important for example for Tiling.

function setXYRepeatabilityUnit¶

public void setXYRepeatabilityUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the XYRepeatabilityUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setXYRepeatabilityUnit¶

public void setXYRepeatabilityUnit(
    UnitsLength_Type value
)

Sets the value of the XYRepeatabilityUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getXYRepeatabilityUnit¶

function resetXYRepeatabilityUnit¶

function hasXYRepeatabilityUnit¶

public boolean hasXYRepeatabilityUnit()

Checks whether the optional XYRepeatabilityUnit attribute is present.

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

No description available in the XSD standard.

function setXTravelRange¶

public void setXTravelRange(
    float value,
    boolean validate
)

Sets the value of the XTravelRange attribute.

Parameters:

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

This field describes the Total Range in the X-axis that this Stage can Travel.

function setXTravelRange¶

public void setXTravelRange(
    float value
)

Sets the value of the XTravelRange attribute.

Parameters:

value The value to set

This field describes the Total Range in the X-axis that this Stage can Travel.

function getXTravelRange¶

function resetXTravelRange¶

function hasXTravelRange¶

public boolean hasXTravelRange()

Checks whether the XTravelRange attribute is present.

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

This field describes the Total Range in the X-axis that this Stage can Travel.

function setXTravelRangeUnit¶

public void setXTravelRangeUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the XTravelRangeUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setXTravelRangeUnit¶

function getXTravelRangeUnit¶

function resetXTravelRangeUnit¶

function hasXTravelRangeUnit¶

public boolean hasXTravelRangeUnit()

Checks whether the optional XTravelRangeUnit attribute is present.

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

No description available in the XSD standard.

function setYTravelRange¶

public void setYTravelRange(
    float value,
    boolean validate
)

Sets the value of the YTravelRange attribute.

Parameters:

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

This field describes the Total Range in the Y-axis that this Stage can Travel.

function setYTravelRange¶

public void setYTravelRange(
    float value
)

Sets the value of the YTravelRange attribute.

Parameters:

value The value to set

This field describes the Total Range in the Y-axis that this Stage can Travel.

function getYTravelRange¶

function resetYTravelRange¶

function hasYTravelRange¶

public boolean hasYTravelRange()

Checks whether the YTravelRange attribute is present.

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

This field describes the Total Range in the Y-axis that this Stage can Travel.

function setYTravelRangeUnit¶

public void setYTravelRangeUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the YTravelRangeUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setYTravelRangeUnit¶

function getYTravelRangeUnit¶

function resetYTravelRangeUnit¶

function hasYTravelRangeUnit¶

public boolean hasYTravelRangeUnit()

Checks whether the optional YTravelRangeUnit attribute is present.

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

No description available in the XSD standard.

function setXYReproducibility¶

public void setXYReproducibility(
    float value,
    boolean validate
)

Sets the value of the XYReproducibility attribute.

Parameters:

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

This field captures the expected Precision with which this Stage is capable of maintaining a given XY-plane Position over time during as specified by the Manufacturer. This metric is generally referred to as Reproducibility and it might also be referred to as Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

function setXYReproducibility¶

public void setXYReproducibility(
    float value
)

Sets the value of the XYReproducibility attribute.

Parameters:

value The value to set

This field captures the expected Precision with which this Stage is capable of maintaining a given XY-plane Position over time during as specified by the Manufacturer. This metric is generally referred to as Reproducibility and it might also be referred to as Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

function getXYReproducibility¶

public float getXYReproducibility()

Returns the value of the XYReproducibility attribute.

Return: The value of the attribute

This field captures the expected Precision with which this Stage is capable of maintaining a given XY-plane Position over time during as specified by the Manufacturer. This metric is generally referred to as Reproducibility and it might also be referred to as Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

function resetXYReproducibility¶

public void resetXYReproducibility()

Resets the XYReproducibility attribute to an unset state.

This field captures the expected Precision with which this Stage is capable of maintaining a given XY-plane Position over time during as specified by the Manufacturer. This metric is generally referred to as Reproducibility and it might also be referred to as Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

function hasXYReproducibility¶

public boolean hasXYReproducibility()

Checks whether the XYReproducibility attribute is present.

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

This field captures the expected Precision with which this Stage is capable of maintaining a given XY-plane Position over time during as specified by the Manufacturer. This metric is generally referred to as Reproducibility and it might also be referred to as Lateral Drift. This metric is particularly relevant for Stereology systems and for the calibration of Sample Positioning devices.

function setXYReproducibilityUnit¶

public void setXYReproducibilityUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the XYReproducibilityUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setXYReproducibilityUnit¶

public void setXYReproducibilityUnit(
    UnitsLength_Type value
)

Sets the value of the XYReproducibilityUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getXYReproducibilityUnit¶

function resetXYReproducibilityUnit¶

function hasXYReproducibilityUnit¶

public boolean hasXYReproducibilityUnit()

Checks whether the optional XYReproducibilityUnit attribute is present.

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

No description available in the XSD standard.

function setXYSettlingTime¶

public void setXYSettlingTime(
    float value,
    boolean validate
)

Sets the value of the XYSettlingTime attribute.

Parameters:

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

This field describes the expected time it takes for this Stage to stabilize at the target XY-plane position, as specified by the Manufacturer.

function setXYSettlingTime¶

public void setXYSettlingTime(
    float value
)

Sets the value of the XYSettlingTime attribute.

Parameters:

value The value to set

This field describes the expected time it takes for this Stage to stabilize at the target XY-plane position, as specified by the Manufacturer.

function getXYSettlingTime¶

public float getXYSettlingTime()

Returns the value of the XYSettlingTime attribute.

Return: The value of the attribute

This field describes the expected time it takes for this Stage to stabilize at the target XY-plane position, as specified by the Manufacturer.

function resetXYSettlingTime¶

public void resetXYSettlingTime()

Resets the XYSettlingTime attribute to an unset state.

This field describes the expected time it takes for this Stage to stabilize at the target XY-plane position, as specified by the Manufacturer.

function hasXYSettlingTime¶

public boolean hasXYSettlingTime()

Checks whether the XYSettlingTime attribute is present.

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

This field describes the expected time it takes for this Stage to stabilize at the target XY-plane position, as specified by the Manufacturer.

function setXYSettlingTimeUnit¶

public void setXYSettlingTimeUnit(
    UnitsTime_Type value,
    boolean validate
)

Sets the value of the XYSettlingTimeUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setXYSettlingTimeUnit¶

public void setXYSettlingTimeUnit(
    UnitsTime_Type value
)

Sets the value of the XYSettlingTimeUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getXYSettlingTimeUnit¶

function resetXYSettlingTimeUnit¶

function hasXYSettlingTimeUnit¶

public boolean hasXYSettlingTimeUnit()

Checks whether the optional XYSettlingTimeUnit attribute is present.

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

No description available in the XSD standard.

function setXYResolution¶

public void setXYResolution(
    float value,
    boolean validate
)

Sets the value of the XYResolution attribute.

Parameters:

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

This field describes the XY-plane motion Resolution of this Stage as specified by the Manufacturer.

function setXYResolution¶

public void setXYResolution(
    float value
)

Sets the value of the XYResolution attribute.

Parameters:

value The value to set

This field describes the XY-plane motion Resolution of this Stage as specified by the Manufacturer.

function getXYResolution¶

public float getXYResolution()

Returns the value of the XYResolution attribute.

Return: The value of the attribute

This field describes the XY-plane motion Resolution of this Stage as specified by the Manufacturer.

function resetXYResolution¶

function hasXYResolution¶

public boolean hasXYResolution()

Checks whether the XYResolution attribute is present.

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

This field describes the XY-plane motion Resolution of this Stage as specified by the Manufacturer.

function setXYZResolutionUnit¶

public void setXYZResolutionUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the XYZResolutionUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setXYZResolutionUnit¶

public void setXYZResolutionUnit(
    UnitsLength_Type value
)

Sets the value of the XYZResolutionUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getXYZResolutionUnit¶

function resetXYZResolutionUnit¶

function hasXYZResolutionUnit¶

public boolean hasXYZResolutionUnit()

Checks whether the optional XYZResolutionUnit attribute is present.

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

No description available in the XSD standard.

function setXYPositionLinearityError¶

public void setXYPositionLinearityError(
    float value,
    boolean validate
)

Sets the value of the XYPositionLinearityError attribute.

Parameters:

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

This field describes the XY-axis positioning error (typically expressed in % error) associated with this Stage as specified by the Manufacturer.

function setXYPositionLinearityError¶

public void setXYPositionLinearityError(
    float value
)

Sets the value of the XYPositionLinearityError attribute.

Parameters:

value The value to set

This field describes the XY-axis positioning error (typically expressed in % error) associated with this Stage as specified by the Manufacturer.

function getXYPositionLinearityError¶

public float getXYPositionLinearityError()

Returns the value of the XYPositionLinearityError attribute.

Return: The value of the attribute

This field describes the XY-axis positioning error (typically expressed in % error) associated with this Stage as specified by the Manufacturer.

function resetXYPositionLinearityError¶

public void resetXYPositionLinearityError()

Resets the XYPositionLinearityError attribute to an unset state.

This field describes the XY-axis positioning error (typically expressed in % error) associated with this Stage as specified by the Manufacturer.

function hasXYPositionLinearityError¶

public boolean hasXYPositionLinearityError()

Checks whether the XYPositionLinearityError attribute is present.

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

This field describes the XY-axis positioning error (typically expressed in % error) associated with this Stage as specified by the Manufacturer.

function __internal_create¶

public static Stage_Type __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.SamplePositioning_Type.__internal_create

Reimplemented by: com.inscoper.nbo.MechanicalStage.__internal_create, com.inscoper.nbo.PiezoElectricStage.__internal_create

function fromBase¶

public static Stage_Type fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a Stage_Type.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.SamplePositioning_Type.fromBase

Reimplemented by: com.inscoper.nbo.MechanicalStage.fromBase, com.inscoper.nbo.PiezoElectricStage.fromBase

Protected Functions Documentation¶

function Stage_Type¶

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.SamplePositioning_Type.swigSetCMemOwn

Reimplemented by: com.inscoper.nbo.MechanicalStage.swigSetCMemOwn, com.inscoper.nbo.PiezoElectricStage.swigSetCMemOwn