com.inscoper.nbo.CalibrationStandardSlide¶

Represents the XML element CalibrationStandardSlide. More...

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

Public Functions¶

	Name
synchronized void	delete()
	CalibrationStandardSlide()
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	setType(CalibrationSlideType_Type value, boolean validate) Sets the value of the Type attribute.
void	setType(CalibrationSlideType_Type value) Sets the value of the Type attribute.
CalibrationSlideType_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	setCalibrationMeasure(CalibrationMeasure_Type value, boolean validate) Sets the value of the CalibrationMeasure attribute.
void	setCalibrationMeasure(CalibrationMeasure_Type value) Sets the value of the CalibrationMeasure attribute.
CalibrationMeasure_Type	getCalibrationMeasure() Returns the value of the CalibrationMeasure attribute.
void	resetCalibrationMeasure() Resets the CalibrationMeasure attribute to an unset state.
boolean	hasCalibrationMeasure() Checks whether the optional CalibrationMeasure attribute is present.
void	setImagedArea(String value, boolean validate) Sets the value of the ImagedArea attribute.
void	setImagedArea(String value) Sets the value of the ImagedArea attribute.
String	getImagedArea() Returns the value of the ImagedArea attribute.
void	resetImagedArea() Resets the ImagedArea attribute to an unset state.
boolean	hasImagedArea() Checks whether the ImagedArea attribute is present.
void	setPatternImageRef(CalibrationStandardSlide_InlinePatternImageRef value, boolean validate) Sets the value of the PatternImageRef element.
void	setPatternImageRef(CalibrationStandardSlide_InlinePatternImageRef value) Sets the value of the PatternImageRef element.
CalibrationStandardSlide_InlinePatternImageRef	getPatternImageRef() Returns the value of the PatternImageRef element.
void	resetPatternImageRef() Resets the PatternImageRef element to an unset state.
boolean	hasPatternImageRef() Checks whether the optional PatternImageRef element is present.
CalibrationStandardSlide	__internal_create(long cPtr, boolean own)
CalibrationStandardSlide	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CalibrationStandardSlide.
StringSet	getImagedAreaAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.OpticalCalibrationStandard_Type

	Name
	OpticalCalibrationStandard_Type()
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	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	setMethod(String value, boolean validate) Sets the value of the Method attribute.
void	setMethod(String value) Sets the value of the Method attribute.
String	getMethod() Returns the value of the Method attribute.
void	resetMethod() Resets the Method attribute to an unset state.
boolean	hasMethod() Checks whether the Method attribute is present.
void	setWavelengthRange_List(WavelengthRangeVector value, boolean validate) Sets the list of WavelengthRange elements.
void	setWavelengthRange_List(WavelengthRangeVector value) Sets the list of WavelengthRange elements.
WavelengthRangeVector	getWavelengthRange_List() Returns the list of WavelengthRange elements.
void	addToWavelengthRange_List(WavelengthRange value, boolean validate) Adds a new WavelengthRange element to this object.
void	addToWavelengthRange_List(WavelengthRange value) Adds a new WavelengthRange element to this object.
void	clearWavelengthRange_List() Clear the list of WavelengthRange.
void	setAnnotationRef_List(AnnotationRefVector value, boolean validate) Sets the list of AnnotationRef elements.
void	setAnnotationRef_List(AnnotationRefVector value) Sets the list of AnnotationRef elements.
AnnotationRefVector	getAnnotationRef_List() Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(AnnotationRef value, boolean validate) Adds a new AnnotationRef element to this object.
void	addToAnnotationRef_List(AnnotationRef value) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
StringSet	getMethodAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.OpticalCalibrationStandard_Type

	Name
	OpticalCalibrationStandard_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.CalibrationStandardSlide;

Represents the XML element CalibrationStandardSlide.

This element describes a Standard Calibration Slide (also referred to as Standard Test Slide) used for assessing the Optical properties of the Microscope that was used to acquire this experimental Image. These Slides can be used to measure multiple different Optical properties including resolution, chromatic registration, magnification, distance, and different kinds of optical distorsions.

Public Functions Documentation¶

function delete¶

function CalibrationStandardSlide¶

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.OpticalCalibrationStandard_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.OpticalCalibrationStandard_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.OpticalCalibrationStandard_Type.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.OpticalCalibrationStandard_Type.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.OpticalCalibrationStandard_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.OpticalCalibrationStandard_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.OpticalCalibrationStandard_Type.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.OpticalCalibrationStandard_Type.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.OpticalCalibrationStandard_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.OpticalCalibrationStandard_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.OpticalCalibrationStandard_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.OpticalCalibrationStandard_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.OpticalCalibrationStandard_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.OpticalCalibrationStandard_Type.toXmlString

function setType¶

public void setType(
    CalibrationSlideType_Type value,
    boolean validate
)

Sets the value of the Type attribute.

Parameters:

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

The type of calibration slide used in this case. Examples include slides produced by Argolight, Geller MicroAnalytical Laboratory, PSFCheck, Zeiss and others.

function setType¶

public void setType(
    CalibrationSlideType_Type value
)

Sets the value of the Type attribute.

Parameters:

value The value to set

The type of calibration slide used in this case. Examples include slides produced by Argolight, Geller MicroAnalytical Laboratory, PSFCheck, Zeiss and others.

function getType¶

public CalibrationSlideType_Type getType()

Returns the value of the Type attribute.

Return: The value of the attribute

The type of calibration slide used in this case. Examples include slides produced by Argolight, Geller MicroAnalytical Laboratory, PSFCheck, Zeiss and others.

function resetType¶

public void resetType()

Resets the Type attribute to an unset state.

The type of calibration slide used in this case. Examples include slides produced by Argolight, Geller MicroAnalytical Laboratory, PSFCheck, Zeiss and others.

function hasType¶

public boolean hasType()

Checks whether the optional Type attribute is present.

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

The type of calibration slide used in this case. Examples include slides produced by Argolight, Geller MicroAnalytical Laboratory, PSFCheck, Zeiss and others.

function setCalibrationMeasure¶

public void setCalibrationMeasure(
    CalibrationMeasure_Type value,
    boolean validate
)

Sets the value of the CalibrationMeasure attribute.

Parameters:

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

This field captures the Optical characteristic this Slide is intended to calibrate, examples include Co-registration Accuracy, Detector linearity, Distance, Magnification, Optical distorsion, Resolution, or Multi.

function setCalibrationMeasure¶

public void setCalibrationMeasure(
    CalibrationMeasure_Type value
)

Sets the value of the CalibrationMeasure attribute.

Parameters:

value The value to set

This field captures the Optical characteristic this Slide is intended to calibrate, examples include Co-registration Accuracy, Detector linearity, Distance, Magnification, Optical distorsion, Resolution, or Multi.

function getCalibrationMeasure¶

public CalibrationMeasure_Type getCalibrationMeasure()

Returns the value of the CalibrationMeasure attribute.

Return: The value of the attribute

This field captures the Optical characteristic this Slide is intended to calibrate, examples include Co-registration Accuracy, Detector linearity, Distance, Magnification, Optical distorsion, Resolution, or Multi.

function resetCalibrationMeasure¶

public void resetCalibrationMeasure()

Resets the CalibrationMeasure attribute to an unset state.

This field captures the Optical characteristic this Slide is intended to calibrate, examples include Co-registration Accuracy, Detector linearity, Distance, Magnification, Optical distorsion, Resolution, or Multi.

function hasCalibrationMeasure¶

public boolean hasCalibrationMeasure()

Checks whether the optional CalibrationMeasure attribute is present.

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

This field captures the Optical characteristic this Slide is intended to calibrate, examples include Co-registration Accuracy, Detector linearity, Distance, Magnification, Optical distorsion, Resolution, or Multi.

function setImagedArea¶

public void setImagedArea(
    String value,
    boolean validate
)

Sets the value of the ImagedArea attribute.

Parameters:

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

This field describes the specific region or sets or regions of the Calibration Slide that have been used for this Optical Calibration procedure.

function setImagedArea¶

public void setImagedArea(
    String value
)

Sets the value of the ImagedArea attribute.

Parameters:

value The value to set

This field describes the specific region or sets or regions of the Calibration Slide that have been used for this Optical Calibration procedure.

function getImagedArea¶

public String getImagedArea()

Returns the value of the ImagedArea attribute.

Return: The value of the attribute

This field describes the specific region or sets or regions of the Calibration Slide that have been used for this Optical Calibration procedure.

function resetImagedArea¶

public void resetImagedArea()

Resets the ImagedArea attribute to an unset state.

This field describes the specific region or sets or regions of the Calibration Slide that have been used for this Optical Calibration procedure.

function hasImagedArea¶

public boolean hasImagedArea()

Checks whether the ImagedArea attribute is present.

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

This field describes the specific region or sets or regions of the Calibration Slide that have been used for this Optical Calibration procedure.

function setPatternImageRef¶

public void setPatternImageRef(
    CalibrationStandardSlide_InlinePatternImageRef value,
    boolean validate
)

Sets the value of the PatternImageRef element.

Parameters:

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

This is an empty element that refers to an Image depcting the pattern etched on this Calibration Slide.

function setPatternImageRef¶

public void setPatternImageRef(
    CalibrationStandardSlide_InlinePatternImageRef value
)

Sets the value of the PatternImageRef element.

Parameters:

value The value to set

This is an empty element that refers to an Image depcting the pattern etched on this Calibration Slide.

function getPatternImageRef¶

public CalibrationStandardSlide_InlinePatternImageRef getPatternImageRef()

Returns the value of the PatternImageRef element.

Return: The value of the element

This is an empty element that refers to an Image depcting the pattern etched on this Calibration Slide.

function resetPatternImageRef¶

function hasPatternImageRef¶

public boolean hasPatternImageRef()

Checks whether the optional PatternImageRef element is present.

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

This is an empty element that refers to an Image depcting the pattern etched on this Calibration Slide.

function __internal_create¶

function fromBase¶

public static CalibrationStandardSlide fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CalibrationStandardSlide.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.OpticalCalibrationStandard_Type.fromBase

function getImagedAreaAllowedValues¶

public static StringSet getImagedAreaAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

This field describes the specific region or sets or regions of the Calibration Slide that have been used for this Optical Calibration procedure.

com.inscoper.nbo.CalibrationStandardSlide¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function CalibrationStandardSlide¶

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

function setType¶

function getType¶

function resetType¶

function hasType¶

function setCalibrationMeasure¶

function setCalibrationMeasure¶

function getCalibrationMeasure¶

function resetCalibrationMeasure¶

function hasCalibrationMeasure¶

function setImagedArea¶

function setImagedArea¶

function getImagedArea¶

function resetImagedArea¶

function hasImagedArea¶

function setPatternImageRef¶

function setPatternImageRef¶

function getPatternImageRef¶

function resetPatternImageRef¶

function hasPatternImageRef¶

function __internal_create¶

function fromBase¶

function getImagedAreaAllowedValues¶

Protected Functions Documentation¶

function CalibrationStandardSlide¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶