com.inscoper.nbo.PrismSettings¶

Represents the XML element PrismSettings. More...

Inherits from com.inscoper.nbo.Settings_Type, com.inscoper.nbo.Reference_Type, com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	PrismSettings()
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(PrismID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(PrismID_Type value) Sets the value of the ID attribute.
PrismID_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	setPositionSetting(PrismPositionSettingList_Type value, boolean validate) Sets the value of the PositionSetting attribute.
void	setPositionSetting(PrismPositionSettingList_Type value) Sets the value of the PositionSetting attribute.
PrismPositionSettingList_Type	getPositionSetting() Returns the value of the PositionSetting attribute.
void	resetPositionSetting() Resets the PositionSetting attribute to an unset state.
boolean	hasPositionSetting() Checks whether the optional PositionSetting attribute is present.
void	setTransmittanceProfileFie_List(FileAnnotation_TypeVector value, boolean validate) Sets the list of TransmittanceProfileFie elements.
void	setTransmittanceProfileFie_List(FileAnnotation_TypeVector value) Sets the list of TransmittanceProfileFie elements.
FileAnnotation_TypeVector	getTransmittanceProfileFie_List() Returns the list of TransmittanceProfileFie elements.
void	addToTransmittanceProfileFie_List(FileAnnotation_Type value, boolean validate) Adds a new TransmittanceProfileFie element to this object.
void	addToTransmittanceProfileFie_List(FileAnnotation_Type value) Adds a new TransmittanceProfileFie element to this object.
void	clearTransmittanceProfileFie_List() Clear the list of TransmittanceProfileFie.
void	setReflectanceProfileFile_List(FileAnnotation_TypeVector value, boolean validate) Sets the list of ReflectanceProfileFile elements.
void	setReflectanceProfileFile_List(FileAnnotation_TypeVector value) Sets the list of ReflectanceProfileFile elements.
FileAnnotation_TypeVector	getReflectanceProfileFile_List() Returns the list of ReflectanceProfileFile elements.
void	addToReflectanceProfileFile_List(FileAnnotation_Type value, boolean validate) Adds a new ReflectanceProfileFile element to this object.
void	addToReflectanceProfileFile_List(FileAnnotation_Type value) Adds a new ReflectanceProfileFile element to this object.
void	clearReflectanceProfileFile_List() Clear the list of ReflectanceProfileFile.
void	setTransmissionWavelengthRangeSettings_List(TransmissionWavelengthRangeSettingsVector value, boolean validate) Sets the list of TransmissionWavelengthRangeSettings elements.
void	setTransmissionWavelengthRangeSettings_List(TransmissionWavelengthRangeSettingsVector value) Sets the list of TransmissionWavelengthRangeSettings elements.
TransmissionWavelengthRangeSettingsVector	getTransmissionWavelengthRangeSettings_List() Returns the list of TransmissionWavelengthRangeSettings elements.
void	addToTransmissionWavelengthRangeSettings_List(TransmissionWavelengthRangeSettings value, boolean validate) Adds a new TransmissionWavelengthRangeSettings element to this object.
void	addToTransmissionWavelengthRangeSettings_List(TransmissionWavelengthRangeSettings value) Adds a new TransmissionWavelengthRangeSettings element to this object.
void	clearTransmissionWavelengthRangeSettings_List() Clear the list of TransmissionWavelengthRangeSettings.
void	setReflectionWavelengthRangeSettings_List(ReflectionWavelengthRangeSettingsVector value, boolean validate) Sets the list of ReflectionWavelengthRangeSettings elements.
void	setReflectionWavelengthRangeSettings_List(ReflectionWavelengthRangeSettingsVector value) Sets the list of ReflectionWavelengthRangeSettings elements.
ReflectionWavelengthRangeSettingsVector	getReflectionWavelengthRangeSettings_List() Returns the list of ReflectionWavelengthRangeSettings elements.
void	addToReflectionWavelengthRangeSettings_List(ReflectionWavelengthRangeSettings value, boolean validate) Adds a new ReflectionWavelengthRangeSettings element to this object.
void	addToReflectionWavelengthRangeSettings_List(ReflectionWavelengthRangeSettings value) Adds a new ReflectionWavelengthRangeSettings element to this object.
void	clearReflectionWavelengthRangeSettings_List() Clear the list of ReflectionWavelengthRangeSettings.
PrismSettings	__internal_create(long cPtr, boolean own)
PrismSettings	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.Settings_Type

	Name
	Settings_Type()
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	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.

Protected Functions inherited from com.inscoper.nbo.Settings_Type

	Name
	Settings_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.Reference_Type

	Name
	Reference_Type()

Protected Functions inherited from com.inscoper.nbo.Reference_Type

	Name
	Reference_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.PrismSettings;

Represents the XML element PrismSettings.

This element holds the Setting applied to a Prism used in the Light Path during the acquisition of this Channel as well as a reference (the ID attribute) to the Prism in question.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.Settings_Type.delete

function PrismSettings¶

public PrismSettings()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.Settings_Type.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.Settings_Type.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.Settings_Type.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.Settings_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.Settings_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.Settings_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.Settings_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.Settings_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.Settings_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.Settings_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.Settings_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.Settings_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.Settings_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.Settings_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.Settings_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.Settings_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.Settings_Type.toXmlString

function setID¶

public void setID(
    PrismID_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.

This is the Unique Identifier of the device used in this case.

function setID¶

public void setID(
    PrismID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

This is the Unique Identifier of the device used in this case.

function getID¶

public PrismID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

This is the Unique Identifier of the device used in this case.

function resetID¶

public void resetID()

Resets the ID attribute to an unset state.

This is the Unique Identifier of the device used in this case.

function hasID¶

public boolean hasID()

Checks whether the optional ID attribute is present.

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

This is the Unique Identifier of the device used in this case.

function setPositionSetting¶

public void setPositionSetting(
    PrismPositionSettingList_Type value,
    boolean validate
)

Sets the value of the PositionSetting attribute.

Parameters:

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

This field refers to the Wollaston Prism position that was set during the Acquisition of this Image. The Position must match the Wollaston Prism Settings found at the base of the objective lens.

function setPositionSetting¶

public void setPositionSetting(
    PrismPositionSettingList_Type value
)

Sets the value of the PositionSetting attribute.

Parameters:

value The value to set

This field refers to the Wollaston Prism position that was set during the Acquisition of this Image. The Position must match the Wollaston Prism Settings found at the base of the objective lens.

function getPositionSetting¶

public PrismPositionSettingList_Type getPositionSetting()

Returns the value of the PositionSetting attribute.

Return: The value of the attribute

This field refers to the Wollaston Prism position that was set during the Acquisition of this Image. The Position must match the Wollaston Prism Settings found at the base of the objective lens.

function resetPositionSetting¶

public void resetPositionSetting()

Resets the PositionSetting attribute to an unset state.

This field refers to the Wollaston Prism position that was set during the Acquisition of this Image. The Position must match the Wollaston Prism Settings found at the base of the objective lens.

function hasPositionSetting¶

public boolean hasPositionSetting()

Checks whether the optional PositionSetting attribute is present.

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

This field refers to the Wollaston Prism position that was set during the Acquisition of this Image. The Position must match the Wollaston Prism Settings found at the base of the objective lens.

function setTransmittanceProfileFie_List¶

public void setTransmittanceProfileFie_List(
    FileAnnotation_TypeVector value,
    boolean validate
)

Sets the list of TransmittanceProfileFie elements.

Parameters:

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

This element records a File in .csv or other suitable formats containing the Transmission Wavelength profile of this hardware component.

function setTransmittanceProfileFie_List¶

public void setTransmittanceProfileFie_List(
    FileAnnotation_TypeVector value
)

Sets the list of TransmittanceProfileFie elements.

Parameters:

value The new list of TransmittanceProfileFie elements

This element records a File in .csv or other suitable formats containing the Transmission Wavelength profile of this hardware component.

function getTransmittanceProfileFie_List¶

public FileAnnotation_TypeVector getTransmittanceProfileFie_List()

Returns the list of TransmittanceProfileFie elements.

Return: The list of TransmittanceProfileFie elements

This element records a File in .csv or other suitable formats containing the Transmission Wavelength profile of this hardware component.

function addToTransmittanceProfileFie_List¶

public void addToTransmittanceProfileFie_List(
    FileAnnotation_Type value,
    boolean validate
)

Adds a new TransmittanceProfileFie element to this object.

Parameters:

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

This element records a File in .csv or other suitable formats containing the Transmission Wavelength profile of this hardware component.

function addToTransmittanceProfileFie_List¶

public void addToTransmittanceProfileFie_List(
    FileAnnotation_Type value
)

Adds a new TransmittanceProfileFie element to this object.

Parameters:

value The element to add

This element records a File in .csv or other suitable formats containing the Transmission Wavelength profile of this hardware component.

function clearTransmittanceProfileFie_List¶

public void clearTransmittanceProfileFie_List()

Clear the list of TransmittanceProfileFie.

This element records a File in .csv or other suitable formats containing the Transmission Wavelength profile of this hardware component.

function setReflectanceProfileFile_List¶

public void setReflectanceProfileFile_List(
    FileAnnotation_TypeVector value,
    boolean validate
)

Sets the list of ReflectanceProfileFile elements.

Parameters:

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

This element records a File in .csv or other suitable formats containing the Reflection Wavelength profile of this hardware component.

function setReflectanceProfileFile_List¶

public void setReflectanceProfileFile_List(
    FileAnnotation_TypeVector value
)

Sets the list of ReflectanceProfileFile elements.

Parameters:

value The new list of ReflectanceProfileFile elements

This element records a File in .csv or other suitable formats containing the Reflection Wavelength profile of this hardware component.

function getReflectanceProfileFile_List¶

public FileAnnotation_TypeVector getReflectanceProfileFile_List()

Returns the list of ReflectanceProfileFile elements.

Return: The list of ReflectanceProfileFile elements

This element records a File in .csv or other suitable formats containing the Reflection Wavelength profile of this hardware component.

function addToReflectanceProfileFile_List¶

public void addToReflectanceProfileFile_List(
    FileAnnotation_Type value,
    boolean validate
)

Adds a new ReflectanceProfileFile element to this object.

Parameters:

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

This element records a File in .csv or other suitable formats containing the Reflection Wavelength profile of this hardware component.

function addToReflectanceProfileFile_List¶

public void addToReflectanceProfileFile_List(
    FileAnnotation_Type value
)

Adds a new ReflectanceProfileFile element to this object.

Parameters:

value The element to add

This element records a File in .csv or other suitable formats containing the Reflection Wavelength profile of this hardware component.

function clearReflectanceProfileFile_List¶

public void clearReflectanceProfileFile_List()

Clear the list of ReflectanceProfileFile.

This element records a File in .csv or other suitable formats containing the Reflection Wavelength profile of this hardware component.

function setTransmissionWavelengthRangeSettings_List¶

public void setTransmissionWavelengthRangeSettings_List(
    TransmissionWavelengthRangeSettingsVector value,
    boolean validate
)

Sets the list of TransmissionWavelengthRangeSettings elements.

Parameters:

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