Skip to content

com.inscoper.nbo.MicroscopeTube

Represents the XML element MicroscopeTube. More...

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

Public Functions

Name
synchronized void delete()
MicroscopeTube()
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(MicroscopeTubeType_Type value, boolean validate)
Sets the value of the Type attribute.
void setType(MicroscopeTubeType_Type value)
Sets the value of the Type attribute.
MicroscopeTubeType_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 setMechanicalLength(float value, boolean validate)
Sets the value of the MechanicalLength attribute.
void setMechanicalLength(float value)
Sets the value of the MechanicalLength attribute.
float getMechanicalLength()
Returns the value of the MechanicalLength attribute.
void resetMechanicalLength()
Resets the MechanicalLength attribute to an unset state.
boolean hasMechanicalLength()
Checks whether the MechanicalLength attribute is present.
void setMechanicalLengthUnit(UnitsLength_Type value, boolean validate)
Sets the value of the MechanicalLengthUnit attribute.
void setMechanicalLengthUnit(UnitsLength_Type value)
Sets the value of the MechanicalLengthUnit attribute.
UnitsLength_Type getMechanicalLengthUnit()
Returns the value of the MechanicalLengthUnit attribute.
void resetMechanicalLengthUnit()
Resets the MechanicalLengthUnit attribute to an unset state.
boolean hasMechanicalLengthUnit()
Checks whether the optional MechanicalLengthUnit attribute is present.
void setOpticalLength(float value, boolean validate)
Sets the value of the OpticalLength attribute.
void setOpticalLength(float value)
Sets the value of the OpticalLength attribute.
float getOpticalLength()
Returns the value of the OpticalLength attribute.
void resetOpticalLength()
Resets the OpticalLength attribute to an unset state.
boolean hasOpticalLength()
Checks whether the OpticalLength attribute is present.
void setOpticalLengthUnit(UnitsLength_Type value, boolean validate)
Sets the value of the OpticalLengthUnit attribute.
void setOpticalLengthUnit(UnitsLength_Type value)
Sets the value of the OpticalLengthUnit attribute.
UnitsLength_Type getOpticalLengthUnit()
Returns the value of the OpticalLengthUnit attribute.
void resetOpticalLengthUnit()
Resets the OpticalLengthUnit attribute to an unset state.
boolean hasOpticalLengthUnit()
Checks whether the optional OpticalLengthUnit attribute is present.
void setFactor(float value, boolean validate)
Sets the value of the Factor attribute.
void setFactor(float value)
Sets the value of the Factor attribute.
float getFactor()
Returns the value of the Factor attribute.
void resetFactor()
Resets the Factor attribute to an unset state.
boolean hasFactor()
Checks whether the Factor attribute is present.
MicroscopeTube __internal_create(long cPtr, boolean own)
MicroscopeTube fromBase(NBOBaseClass base)
Cast a NBOBaseClass to a MicroscopeTube.

Protected Functions

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

Additional inherited members

Public Functions inherited from com.inscoper.nbo.OpticalAssembly_Type

Name
OpticalAssembly_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 setFilterRef_List(FilterRef_TypeVector value, boolean validate)
Sets the list of FilterRef elements.
void setFilterRef_List(FilterRef_TypeVector value)
Sets the list of FilterRef elements.
FilterRef_TypeVector getFilterRef_List()
Returns the list of FilterRef elements.
void addToFilterRef_List(FilterRef_Type value, boolean validate)
Adds a new FilterRef element to this object.
void addToFilterRef_List(FilterRef_Type value)
Adds a new FilterRef element to this object.
void clearFilterRef_List()
Clear the list of FilterRef.
void setLensRef_List(LensRefVector value, boolean validate)
Sets the list of LensRef elements.
void setLensRef_List(LensRefVector value)
Sets the list of LensRef elements.
LensRefVector getLensRef_List()
Returns the list of LensRef elements.
void addToLensRef_List(LensRef value, boolean validate)
Adds a new LensRef element to this object.
void addToLensRef_List(LensRef value)
Adds a new LensRef element to this object.
void clearLensRef_List()
Clear the list of LensRef.
void setMirroringDeviceRef_List(MirroringDeviceRefVector value, boolean validate)
Sets the list of MirroringDeviceRef elements.
void setMirroringDeviceRef_List(MirroringDeviceRefVector value)
Sets the list of MirroringDeviceRef elements.
MirroringDeviceRefVector getMirroringDeviceRef_List()
Returns the list of MirroringDeviceRef elements.
void addToMirroringDeviceRef_List(MirroringDeviceRef value, boolean validate)
Adds a new MirroringDeviceRef element to this object.
void addToMirroringDeviceRef_List(MirroringDeviceRef value)
Adds a new MirroringDeviceRef element to this object.
void clearMirroringDeviceRef_List()
Clear the list of MirroringDeviceRef.
void setApertureRef_List(ApertureRefVector value, boolean validate)
Sets the list of ApertureRef elements.
void setApertureRef_List(ApertureRefVector value)
Sets the list of ApertureRef elements.
ApertureRefVector getApertureRef_List()
Returns the list of ApertureRef elements.
void addToApertureRef_List(ApertureRef value, boolean validate)
Adds a new ApertureRef element to this object.
void addToApertureRef_List(ApertureRef value)
Adds a new ApertureRef element to this object.
void clearApertureRef_List()
Clear the list of ApertureRef.
void setPolarizationOpticsRef_List(PolarizationOpticsRefVector value, boolean validate)
Sets the list of PolarizationOpticsRef elements.
void setPolarizationOpticsRef_List(PolarizationOpticsRefVector value)
Sets the list of PolarizationOpticsRef elements.
PolarizationOpticsRefVector getPolarizationOpticsRef_List()
Returns the list of PolarizationOpticsRef elements.
void addToPolarizationOpticsRef_List(PolarizationOpticsRef value, boolean validate)
Adds a new PolarizationOpticsRef element to this object.
void addToPolarizationOpticsRef_List(PolarizationOpticsRef value)
Adds a new PolarizationOpticsRef element to this object.
void clearPolarizationOpticsRef_List()
Clear the list of PolarizationOpticsRef.
void setPrismRef_List(PrismRefVector value, boolean validate)
Sets the list of PrismRef elements.
void setPrismRef_List(PrismRefVector value)
Sets the list of PrismRef elements.
PrismRefVector getPrismRef_List()
Returns the list of PrismRef elements.
void addToPrismRef_List(PrismRef value, boolean validate)
Adds a new PrismRef element to this object.
void addToPrismRef_List(PrismRef value)
Adds a new PrismRef element to this object.
void clearPrismRef_List()
Clear the list of PrismRef.
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.OpticalAssembly_Type

Name
OpticalAssembly_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.MicroscopeTube;

Represents the XML element MicroscopeTube.

Illumination Tubes are Lens systems, which might be embedded within the Microscope Stand and therefore not immediately accessible. They are essential for infinity-correction and should be regarded as integral parts of the Objective Lens System when magnification and correction are considered.

Public Functions Documentation

function delete

function MicroscopeTube

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 setMechanicalLength

function setMechanicalLength

function getMechanicalLength

function resetMechanicalLength

function hasMechanicalLength

function setMechanicalLengthUnit

function setMechanicalLengthUnit

function getMechanicalLengthUnit

function resetMechanicalLengthUnit

function hasMechanicalLengthUnit

function setOpticalLength

function setOpticalLength

function getOpticalLength

function resetOpticalLength

function hasOpticalLength

function setOpticalLengthUnit

function setOpticalLengthUnit

function getOpticalLengthUnit

function resetOpticalLengthUnit

function hasOpticalLengthUnit

function setFactor

function setFactor

function getFactor

function resetFactor

function hasFactor

function __internal_create

function fromBase

Protected Functions Documentation

function MicroscopeTube

function swigSetCMemOwn

function finalize

function getCPtr