com.inscoper.nbo.CoverGlass¶

Represents the XML element CoverGlass. More...

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

Public Functions¶

	Name
synchronized void	delete()
	CoverGlass()
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	setID(LSID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(LSID_Type value) Sets the value of the ID attribute.
LSID_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	setCoating(String value, boolean validate) Sets the value of the Coating attribute.
void	setCoating(String value) Sets the value of the Coating attribute.
String	getCoating() Returns the value of the Coating attribute.
void	resetCoating() Resets the Coating attribute to an unset state.
boolean	hasCoating() Checks whether the Coating attribute is present.
void	setCoverGlassNo(CoverGlassNr_Type value, boolean validate) Sets the value of the CoverGlassNo attribute.
void	setCoverGlassNo(CoverGlassNr_Type value) Sets the value of the CoverGlassNo attribute.
CoverGlassNr_Type	getCoverGlassNo() Returns the value of the CoverGlassNo attribute.
void	resetCoverGlassNo() Resets the CoverGlassNo attribute to an unset state.
boolean	hasCoverGlassNo() Checks whether the optional CoverGlassNo attribute is present.
void	setThickness(float value, boolean validate) Sets the value of the Thickness attribute.
void	setThickness(float value) Sets the value of the Thickness attribute.
float	getThickness() Returns the value of the Thickness attribute.
void	resetThickness() Resets the Thickness attribute to an unset state.
boolean	hasThickness() Checks whether the Thickness attribute is present.
CoverGlass	__internal_create(long cPtr, boolean own)
CoverGlass	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CoverGlass.
StringSet	getCoatingAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

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

Additional inherited members¶

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

Represents the XML element CoverGlass.

This element describes a rectangular or circular piece of thin glass used to cover a microscopical preparation.

Public Functions Documentation¶

function delete¶

function CoverGlass¶

function getTypeName¶

function getXMLName¶

function 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.ManufacturerSpec_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.ManufacturerSpec_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.ManufacturerSpec_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.ManufacturerSpec_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.ManufacturerSpec_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.ManufacturerSpec_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.ManufacturerSpec_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.ManufacturerSpec_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.ManufacturerSpec_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.ManufacturerSpec_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.ManufacturerSpec_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.ManufacturerSpec_Type.toXmlString

function setID¶

public void setID(
    LSID_Type value,
    boolean validate
)

Sets the value of the ID attribute.

Parameters:

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

A Unique Identifier for this component.

function setID¶

function getID¶

function resetID¶

function hasID¶

function setCoating¶

public void setCoating(
    String value,
    boolean validate
)

Sets the value of the Coating attribute.

Parameters:

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

This field reports a description for any Coating that was layered on the Cover Glass, either by the Manufacturer or after purchase (e.g., Poly-L-Lysine, Collagen).

function setCoating¶

public void setCoating(
    String value
)

Sets the value of the Coating attribute.

Parameters:

value The value to set

This field reports a description for any Coating that was layered on the Cover Glass, either by the Manufacturer or after purchase (e.g., Poly-L-Lysine, Collagen).

function getCoating¶

public String getCoating()

Returns the value of the Coating attribute.

Return: The value of the attribute

This field reports a description for any Coating that was layered on the Cover Glass, either by the Manufacturer or after purchase (e.g., Poly-L-Lysine, Collagen).

function resetCoating¶

public void resetCoating()

Resets the Coating attribute to an unset state.

This field reports a description for any Coating that was layered on the Cover Glass, either by the Manufacturer or after purchase (e.g., Poly-L-Lysine, Collagen).

function hasCoating¶

public boolean hasCoating()

Checks whether the Coating attribute is present.

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

This field reports a description for any Coating that was layered on the Cover Glass, either by the Manufacturer or after purchase (e.g., Poly-L-Lysine, Collagen).

function setCoverGlassNo¶

public void setCoverGlassNo(
    CoverGlassNr_Type value,
    boolean validate
)

Sets the value of the CoverGlassNo attribute.

Parameters:

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

This fields reports the numerical designation that describes the expected thickness of this Coverslip (e.g., #1.5) and the relative expected thickness range expressed in mm.

function setCoverGlassNo¶

public void setCoverGlassNo(
    CoverGlassNr_Type value
)

Sets the value of the CoverGlassNo attribute.

Parameters:

value The value to set

This fields reports the numerical designation that describes the expected thickness of this Coverslip (e.g., #1.5) and the relative expected thickness range expressed in mm.

function getCoverGlassNo¶

public CoverGlassNr_Type getCoverGlassNo()

Returns the value of the CoverGlassNo attribute.

Return: The value of the attribute

This fields reports the numerical designation that describes the expected thickness of this Coverslip (e.g., #1.5) and the relative expected thickness range expressed in mm.

function resetCoverGlassNo¶

public void resetCoverGlassNo()

Resets the CoverGlassNo attribute to an unset state.

This fields reports the numerical designation that describes the expected thickness of this Coverslip (e.g., #1.5) and the relative expected thickness range expressed in mm.

function hasCoverGlassNo¶

public boolean hasCoverGlassNo()

Checks whether the optional CoverGlassNo attribute is present.

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

This fields reports the numerical designation that describes the expected thickness of this Coverslip (e.g., #1.5) and the relative expected thickness range expressed in mm.

function setThickness¶

public void setThickness(
    float value,
    boolean validate
)

Sets the value of the Thickness attribute.

Parameters:

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

This fields reports the measured thickness of this Coverslip expressed in mm.

function setThickness¶

public void setThickness(
    float value
)

Sets the value of the Thickness attribute.

Parameters:

value The value to set

This fields reports the measured thickness of this Coverslip expressed in mm.

function getThickness¶

function resetThickness¶

function hasThickness¶

public boolean hasThickness()

Checks whether the Thickness attribute is present.

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

This fields reports the measured thickness of this Coverslip expressed in mm.

function __internal_create¶

function fromBase¶

public static CoverGlass fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CoverGlass.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromBase

function getCoatingAllowedValues¶

public static StringSet getCoatingAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

This field reports a description for any Coating that was layered on the Cover Glass, either by the Manufacturer or after purchase (e.g., Poly-L-Lysine, Collagen).

com.inscoper.nbo.CoverGlass¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function CoverGlass¶

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

function setID¶

function getID¶

function resetID¶

function hasID¶

function setCoating¶

function setCoating¶

function getCoating¶

function resetCoating¶

function hasCoating¶

function setCoverGlassNo¶

function setCoverGlassNo¶

function getCoverGlassNo¶

function resetCoverGlassNo¶

function hasCoverGlassNo¶

function setThickness¶

function setThickness¶

function getThickness¶

function resetThickness¶

function hasThickness¶

function __internal_create¶

function fromBase¶

function getCoatingAllowedValues¶

Protected Functions Documentation¶

function CoverGlass¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶