com.inscoper.nbo.StageLabel¶

Represents the XML element StageLabel. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	StageLabel()
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	setName(String value, boolean validate) Sets the value of the Name attribute.
void	setName(String value) Sets the value of the Name attribute.
String	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the Name attribute is present.
void	setX(float value, boolean validate) Sets the value of the X attribute.
void	setX(float value) Sets the value of the X attribute.
float	getX() Returns the value of the X attribute.
void	resetX() Resets the X attribute to an unset state.
boolean	hasX() Checks whether the X attribute is present.
void	setXUnits(UnitsLength_Type value, boolean validate) Sets the value of the XUnits attribute.
void	setXUnits(UnitsLength_Type value) Sets the value of the XUnits attribute.
UnitsLength_Type	getXUnits() Returns the value of the XUnits attribute.
void	resetXUnits() Resets the XUnits attribute to an unset state.
boolean	hasXUnits() Checks whether the optional XUnits attribute is present.
void	setY(float value, boolean validate) Sets the value of the Y attribute.
void	setY(float value) Sets the value of the Y attribute.
float	getY() Returns the value of the Y attribute.
void	resetY() Resets the Y attribute to an unset state.
boolean	hasY() Checks whether the Y attribute is present.
void	setYUnits(UnitsLength_Type value, boolean validate) Sets the value of the YUnits attribute.
void	setYUnits(UnitsLength_Type value) Sets the value of the YUnits attribute.
UnitsLength_Type	getYUnits() Returns the value of the YUnits attribute.
void	resetYUnits() Resets the YUnits attribute to an unset state.
boolean	hasYUnits() Checks whether the optional YUnits attribute is present.
void	setZ(float value, boolean validate) Sets the value of the Z attribute.
void	setZ(float value) Sets the value of the Z attribute.
float	getZ() Returns the value of the Z attribute.
void	resetZ() Resets the Z attribute to an unset state.
boolean	hasZ() Checks whether the Z attribute is present.
void	setZUnits(UnitsLength_Type value, boolean validate) Sets the value of the ZUnits attribute.
void	setZUnits(UnitsLength_Type value) Sets the value of the ZUnits attribute.
UnitsLength_Type	getZUnits() Returns the value of the ZUnits attribute.
void	resetZUnits() Resets the ZUnits attribute to an unset state.
boolean	hasZUnits() Checks whether the optional ZUnits attribute is present.
StageLabel	__internal_create(long cPtr, boolean own)
StageLabel	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a StageLabel.
StringSet	getNameAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

	Name
	StageLabel(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(StageLabel 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.StageLabel;

Represents the XML element StageLabel.

The StageLabel is used to specify the Name and Position for a Stage position in the Microscope's reference frame.

Public Functions Documentation¶

function delete¶

function StageLabel¶

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.NBOBaseClass.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.

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.

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

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.

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

function 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

function toXmlString¶

function setName¶

public void setName(
    String value,
    boolean validate
)

Sets the value of the Name attribute.

Parameters:

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

A User-defined Name for this Stage Label.

function setName¶

function getName¶

function resetName¶

function hasName¶

function setX¶

public void setX(
    float value,
    boolean validate
)

Sets the value of the X attribute.

Parameters:

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

The X position of this StageLabel.

function setX¶

function getX¶

function resetX¶

function hasX¶

function setXUnits¶

public void setXUnits(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the XUnits 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 setXUnits¶

function getXUnits¶

function resetXUnits¶

function hasXUnits¶

public boolean hasXUnits()

Checks whether the optional XUnits attribute is present.

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

No description available in the XSD standard.

function setY¶

public void setY(
    float value,
    boolean validate
)

Sets the value of the Y attribute.

Parameters:

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

The Y position of this StageLabel.

function setY¶

function getY¶

function resetY¶

function hasY¶

function setYUnits¶

public void setYUnits(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the YUnits 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 setYUnits¶

function getYUnits¶

function resetYUnits¶

function hasYUnits¶

public boolean hasYUnits()

Checks whether the optional YUnits attribute is present.

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

No description available in the XSD standard.

function setZ¶

public void setZ(
    float value,
    boolean validate
)

Sets the value of the Z attribute.

Parameters:

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

The Z position of this StageLabel.

function setZ¶

function getZ¶

function resetZ¶

function hasZ¶

function setZUnits¶

public void setZUnits(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the ZUnits 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 setZUnits¶

function getZUnits¶

function resetZUnits¶

function hasZUnits¶

public boolean hasZUnits()

Checks whether the optional ZUnits attribute is present.

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

No description available in the XSD standard.

function __internal_create¶

function fromBase¶

public static StageLabel fromBase(
    NBOBaseClass base
)

com.inscoper.nbo.StageLabel¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function StageLabel¶

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 setName¶

function setName¶

function getName¶

function resetName¶

function hasName¶

function setX¶

function setX¶

function getX¶

function resetX¶

function hasX¶

function setXUnits¶

function setXUnits¶

function getXUnits¶

function resetXUnits¶

function hasXUnits¶

function setY¶

function setY¶

function getY¶

function resetY¶

function hasY¶

function setYUnits¶

function setYUnits¶

function getYUnits¶

function resetYUnits¶

function hasYUnits¶

function setZ¶

function setZ¶

function getZ¶

function resetZ¶

function hasZ¶

function setZUnits¶

function setZUnits¶

function getZUnits¶

function resetZUnits¶

function hasZUnits¶

function __internal_create¶

function fromBase¶

function getNameAllowedValues¶

Protected Functions Documentation¶

function StageLabel¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶