Skip to content

com.inscoper.nbo.Z_Drive

Represents the XML element Z-Drive. More...

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

Public Functions

Name
synchronized void delete()
Z_Drive()
String getTypeName()
Returns the class type name.
String getXMLName()
Returns the XML element name corresponding to this class.
ENBOType getNBOType()
Returns the NBO Type corresponding to this class.
NBOBaseClassVector getChildren()
Returns a list of all classes derived from this class.
NBOBaseClassVector getSubElements()
Returns a list of all child elements contained in this class.
void fromJsonFile(String path)
Populates this object from a JSON file.
void fromJsonString(String json_string)
Populates this object from a JSON string.
void fromXmlFile(String path)
Populates this object from a XML file.
void fromXmlString(String xml_string)
Populates this object from a XML string.
void toXmlFile(String filename)
Serializes this object to an XML file.
String toXmlString()
Serializes this object to an XML string.
Z_Drive __internal_create(long cPtr, boolean own)

Protected Functions

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

Additional inherited members

Public Functions inherited from com.inscoper.nbo.SamplePositioning_Type

Name
SamplePositioning_Type()
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)
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)
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)
Sets the value of the Motorized attribute.
boolean getMotorized()
Returns the value of the Motorized 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 optional ZMaxVelocity attribute is present.
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)
Sets the value of the ZRepeatability attribute.
float getZRepeatability()
Returns the value of the ZRepeatability 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)
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 optional ZTravelRange attribute is present.
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)
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)
Sets the value of the BuiltIn attribute.
boolean getBuiltIn()
Returns the value of the BuiltIn 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 optional ZReproducibility attribute is present.
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)
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 optional ZSettlingTime attribute is present.
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)
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 optional ZResolution attribute is present.
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)
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 optional ZPositionLinearityError attribute is present.
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)
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 optional RotationAngle attribute is present.
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)
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)
Sets the value of the Manufacturer attribute.
String getManufacturer()
Returns the value of the Manufacturer attribute.
void setModel(String value)
Sets the value of the Model attribute.
String getModel()
Returns the value of the Model attribute.
void setCatalogNumber(String value)
Sets the value of the CatalogNumber attribute.
String getCatalogNumber()
Returns the value of the CatalogNumber attribute.
void setLotNumber(String value)
Sets the value of the LotNumber attribute.
String getLotNumber()
Returns the value of the LotNumber attribute.
void resetLotNumber()
Resets the LotNumber attribute to an unset state.
boolean hasLotNumber()
Checks whether the optional LotNumber attribute is present.
void setMapAnnotation_List(MapAnnotationVector value)
Sets the list of MapAnnotation elements.
MapAnnotationVector getMapAnnotation_List()
Returns the list of MapAnnotation elements.
void addToMapAnnotation_List(MapAnnotation value)
Adds a new MapAnnotation element to this object.
void clearMapAnnotation_List()
Clear the list of MapAnnotation.
void setSpecsFile(FileAnnotation_Type value)
Sets the value of the SpecsFile element.
FileAnnotation_Type getSpecsFile()
Returns the value of the SpecsFile element.
void resetSpecsFile()
Resets the SpecsFile element to an unset state.
boolean hasSpecsFile()
Checks whether the optional SpecsFile element is present.
void setAdditionalVendorInformation_List(AdditionalVendorInformationVector value)
Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector getAdditionalVendorInformation_List()
Returns the list of AdditionalVendorInformation elements.
void addToAdditionalVendorInformation_List(AdditionalVendorInformation value)
Adds a new AdditionalVendorInformation element to this object.
void clearAdditionalVendorInformation_List()
Clear the list of AdditionalVendorInformation.

Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

Name
ManufacturerSpec_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

Name
NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.Z_Drive;

Represents the XML element Z-Drive.

This element describes a Focusing Device designed to electronically control a moving a mechanical part of the Microscope such as the Stage (see Stage-APE), or the Microscope Stand itself (e.g. most dissecting Microscopes). An example of such devices is the MFC-2000 Z-Axis Drive and Controller (http://www.asiimaging.com/controllers/mfc-2000-z-axis-drive-and-controller/#tab-id-4).

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.SamplePositioning_Type.delete

function Z_Drive

public Z_Drive()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.SamplePositioning_Type.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

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

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

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

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

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

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

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

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

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

function __internal_create

public static Z_Drive __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.SamplePositioning_Type.__internal_create

Protected Functions Documentation

function Z_Drive

protected Z_Drive(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.SamplePositioning_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.SamplePositioning_Type.finalize

function getCPtr

protected static long getCPtr(
    Z_Drive obj
)

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