com.inscoper.nbo.OpticsTurret¶

Represents the XML element OpticsTurret. More...

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

Public Functions¶

	Name
synchronized void	delete()
	OpticsTurret()
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	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	setFilterRef_List(FilterRefVector value, boolean validate) Sets the list of FilterRef elements.
void	setFilterRef_List(FilterRefVector value) Sets the list of FilterRef elements.
FilterRefVector	getFilterRef_List() Returns the list of FilterRef elements.
void	addToFilterRef_List(FilterRef value, boolean validate) Adds a new FilterRef element to this object.
void	addToFilterRef_List(FilterRef value) Adds a new FilterRef element to this object.
void	clearFilterRef_List() Clear the list of FilterRef.
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	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.
OpticsTurret	__internal_create(long cPtr, boolean own)
OpticsTurret	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a OpticsTurret.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.OpticsHolder_Type

	Name
	OpticsHolder_Type()
void	setID(LensID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(LensID_Type value) Sets the value of the ID attribute.
LensID_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	setMotorized(boolean value, boolean validate) Sets the value of the Motorized attribute.
void	setMotorized(boolean value) Sets the value of the Motorized attribute.
boolean	getMotorized() Returns the value of the Motorized attribute.
void	resetMotorized() Resets the Motorized attribute to an unset state.
boolean	hasMotorized() Checks whether the Motorized attribute is present.
void	setResponseTime(float value, boolean validate) Sets the value of the ResponseTime attribute.
void	setResponseTime(float value) Sets the value of the ResponseTime attribute.
float	getResponseTime() Returns the value of the ResponseTime attribute.
void	resetResponseTime() Resets the ResponseTime attribute to an unset state.
boolean	hasResponseTime() Checks whether the ResponseTime attribute is present.
void	setResponseTimeUnit(UnitsTime_Type value, boolean validate) Sets the value of the ResponseTimeUnit attribute.
void	setResponseTimeUnit(UnitsTime_Type value) Sets the value of the ResponseTimeUnit attribute.
UnitsTime_Type	getResponseTimeUnit() Returns the value of the ResponseTimeUnit attribute.
void	resetResponseTimeUnit() Resets the ResponseTimeUnit attribute to an unset state.
boolean	hasResponseTimeUnit() Checks whether the optional ResponseTimeUnit attribute is present.
void	setNrOfSlots(long value, boolean validate) Sets the value of the NrOfSlots attribute.
void	setNrOfSlots(long value) Sets the value of the NrOfSlots attribute.
long	getNrOfSlots() Returns the value of the NrOfSlots attribute.
void	resetNrOfSlots() Resets the NrOfSlots attribute to an unset state.
boolean	hasNrOfSlots() Checks whether the NrOfSlots attribute is present.
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.OpticsHolder_Type

	Name
	OpticsHolder_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.OpticsTurret;

Represents the XML element OpticsTurret.

This element represents a circular holder for multiple optical elements.

Public Functions Documentation¶

function delete¶

function OpticsTurret¶

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.OpticsHolder_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.OpticsHolder_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.OpticsHolder_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.OpticsHolder_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.OpticsHolder_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.OpticsHolder_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.OpticsHolder_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.OpticsHolder_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.OpticsHolder_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.OpticsHolder_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.OpticsHolder_Type.toXmlString

function setLensRef_List¶

public void setLensRef_List(
    LensRefVector value,
    boolean validate
)

Sets the list of LensRef elements.

Parameters:

value The new list of LensRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setLensRef_List¶

function getLensRef_List¶

function addToLensRef_List¶

public void addToLensRef_List(
    LensRef value,
    boolean validate
)

Adds a new LensRef element to this object.

Parameters:

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

No description available in the XSD standard.

function addToLensRef_List¶

function clearLensRef_List¶

function setMirroringDeviceRef_List¶

public void setMirroringDeviceRef_List(
    MirroringDeviceRefVector value,
    boolean validate
)

Sets the list of MirroringDeviceRef elements.

Parameters:

value The new list of MirroringDeviceRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setMirroringDeviceRef_List¶

public void setMirroringDeviceRef_List(
    MirroringDeviceRefVector value
)

Sets the list of MirroringDeviceRef elements.

Parameters:

value The new list of MirroringDeviceRef elements

No description available in the XSD standard.

function getMirroringDeviceRef_List¶

public MirroringDeviceRefVector getMirroringDeviceRef_List()

Returns the list of MirroringDeviceRef elements.

Return: The list of MirroringDeviceRef elements

No description available in the XSD standard.

function addToMirroringDeviceRef_List¶

public void addToMirroringDeviceRef_List(
    MirroringDeviceRef value,
    boolean validate
)

Adds a new MirroringDeviceRef element to this object.

Parameters:

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

No description available in the XSD standard.

function addToMirroringDeviceRef_List¶

public void addToMirroringDeviceRef_List(
    MirroringDeviceRef value
)

Adds a new MirroringDeviceRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearMirroringDeviceRef_List¶

function setApertureRef_List¶

public void setApertureRef_List(
    ApertureRefVector value,
    boolean validate
)

Sets the list of ApertureRef elements.

Parameters:

value The new list of ApertureRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setApertureRef_List¶

public void setApertureRef_List(
    ApertureRefVector value
)

Sets the list of ApertureRef elements.

Parameters:

value The new list of ApertureRef elements

No description available in the XSD standard.

function getApertureRef_List¶

function addToApertureRef_List¶

public void addToApertureRef_List(
    ApertureRef value,
    boolean validate
)

Adds a new ApertureRef element to this object.

Parameters:

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

No description available in the XSD standard.

function addToApertureRef_List¶

function clearApertureRef_List¶

function setFilterRef_List¶

public void setFilterRef_List(
    FilterRefVector value,
    boolean validate
)

Sets the list of FilterRef elements.

Parameters:

value The new list of FilterRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setFilterRef_List¶

public void setFilterRef_List(
    FilterRefVector value
)

Sets the list of FilterRef elements.

Parameters:

value The new list of FilterRef elements

No description available in the XSD standard.

function getFilterRef_List¶

function addToFilterRef_List¶

public void addToFilterRef_List(
    FilterRef value,
    boolean validate
)

Adds a new FilterRef element to this object.

Parameters:

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

No description available in the XSD standard.

function addToFilterRef_List¶

function clearFilterRef_List¶

function setPrismRef_List¶

public void setPrismRef_List(
    PrismRefVector value,
    boolean validate
)

Sets the list of PrismRef elements.

Parameters:

value The new list of PrismRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPrismRef_List¶

function getPrismRef_List¶

function addToPrismRef_List¶

public void addToPrismRef_List(
    PrismRef value,
    boolean validate
)

Adds a new PrismRef element to this object.

Parameters:

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

No description available in the XSD standard.

function addToPrismRef_List¶

function clearPrismRef_List¶

function setPolarizationOpticsRef_List¶

public void setPolarizationOpticsRef_List(
    PolarizationOpticsRefVector value,
    boolean validate
)

Sets the list of PolarizationOpticsRef elements.

Parameters:

value The new list of PolarizationOpticsRef elements
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPolarizationOpticsRef_List¶

public void setPolarizationOpticsRef_List(
    PolarizationOpticsRefVector value
)

Sets the list of PolarizationOpticsRef elements.

Parameters:

value The new list of PolarizationOpticsRef elements

No description available in the XSD standard.

function getPolarizationOpticsRef_List¶

public PolarizationOpticsRefVector getPolarizationOpticsRef_List()

Returns the list of PolarizationOpticsRef elements.

Return: The list of PolarizationOpticsRef elements

No description available in the XSD standard.

function addToPolarizationOpticsRef_List¶

public void addToPolarizationOpticsRef_List(
    PolarizationOpticsRef value,
    boolean validate
)

Adds a new PolarizationOpticsRef element to this object.

Parameters:

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

No description available in the XSD standard.

function addToPolarizationOpticsRef_List¶

public void addToPolarizationOpticsRef_List(
    PolarizationOpticsRef value
)

Adds a new PolarizationOpticsRef element to this object.

Parameters:

value The element to add

No description available in the XSD standard.

function clearPolarizationOpticsRef_List¶

function __internal_create¶

function fromBase¶

public static OpticsTurret fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a OpticsTurret.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.OpticsHolder_Type.fromBase

com.inscoper.nbo.OpticsTurret¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function OpticsTurret¶

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

function setLensRef_List¶

function getLensRef_List¶

function addToLensRef_List¶

function addToLensRef_List¶

function clearLensRef_List¶

function setMirroringDeviceRef_List¶

function setMirroringDeviceRef_List¶

function getMirroringDeviceRef_List¶

function addToMirroringDeviceRef_List¶

function addToMirroringDeviceRef_List¶

function clearMirroringDeviceRef_List¶

function setApertureRef_List¶

function setApertureRef_List¶

function getApertureRef_List¶

function addToApertureRef_List¶

function addToApertureRef_List¶

function clearApertureRef_List¶

function setFilterRef_List¶

function setFilterRef_List¶

function getFilterRef_List¶

function addToFilterRef_List¶

function addToFilterRef_List¶

function clearFilterRef_List¶

function setPrismRef_List¶

function setPrismRef_List¶

function getPrismRef_List¶

function addToPrismRef_List¶

function addToPrismRef_List¶

function clearPrismRef_List¶

function setPolarizationOpticsRef_List¶

function setPolarizationOpticsRef_List¶

function getPolarizationOpticsRef_List¶

function addToPolarizationOpticsRef_List¶

function addToPolarizationOpticsRef_List¶

function clearPolarizationOpticsRef_List¶

function __internal_create¶

function fromBase¶

Protected Functions Documentation¶

function OpticsTurret¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶