com.inscoper.nbo.ExcitationFilter¶

Represents the XML element ExcitationFilter. More...

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

Public Functions¶

	Name
synchronized void	delete()
	ExcitationFilter()
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.
ExcitationFilter	__internal_create(long cPtr, boolean own)
ExcitationFilter	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a ExcitationFilter.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.Filter_Type

	Name
	Filter_Type()
void	setID(FilterID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(FilterID_Type value) Sets the value of the ID attribute.
FilterID_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	setType(FilterType_Type value, boolean validate) Sets the value of the Type attribute.
void	setType(FilterType_Type value) Sets the value of the Type attribute.
FilterType_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	setCoatingMethod(CoatingMethod_Type value, boolean validate) Sets the value of the CoatingMethod attribute.
void	setCoatingMethod(CoatingMethod_Type value) Sets the value of the CoatingMethod attribute.
CoatingMethod_Type	getCoatingMethod() Returns the value of the CoatingMethod attribute.
void	resetCoatingMethod() Resets the CoatingMethod attribute to an unset state.
boolean	hasCoatingMethod() Checks whether the optional CoatingMethod attribute is present.
void	setLightPathLocation(LightPathLocationOptions_Type value, boolean validate) Sets the value of the LightPathLocation attribute.
void	setLightPathLocation(LightPathLocationOptions_Type value) Sets the value of the LightPathLocation attribute.
LightPathLocationOptions_Type	getLightPathLocation() Returns the value of the LightPathLocation attribute.
void	resetLightPathLocation() Resets the LightPathLocation attribute to an unset state.
boolean	hasLightPathLocation() Checks whether the optional LightPathLocation attribute is present.
void	setFilterHolderPosition(int value, boolean validate) Sets the value of the FilterHolderPosition attribute.
void	setFilterHolderPosition(int value) Sets the value of the FilterHolderPosition attribute.
int	getFilterHolderPosition() Returns the value of the FilterHolderPosition attribute.
void	resetFilterHolderPosition() Resets the FilterHolderPosition attribute to an unset state.
boolean	hasFilterHolderPosition() Checks whether the FilterHolderPosition attribute is present.
void	setTechnology(FilterTechnologyType_Type value, boolean validate) Sets the value of the Technology attribute.
void	setTechnology(FilterTechnologyType_Type value) Sets the value of the Technology attribute.
FilterTechnologyType_Type	getTechnology() Returns the value of the Technology attribute.
void	resetTechnology() Resets the Technology attribute to an unset state.
boolean	hasTechnology() Checks whether the optional Technology attribute is present.
void	setAttenuationMethod(AttenuationMethodType_Type value, boolean validate) Sets the value of the AttenuationMethod attribute.
void	setAttenuationMethod(AttenuationMethodType_Type value) Sets the value of the AttenuationMethod attribute.
AttenuationMethodType_Type	getAttenuationMethod() Returns the value of the AttenuationMethod attribute.
void	resetAttenuationMethod() Resets the AttenuationMethod attribute to an unset state.
boolean	hasAttenuationMethod() Checks whether the optional AttenuationMethod attribute is present.
void	setAttenuationCoefficient(float value, boolean validate) Sets the value of the AttenuationCoefficient attribute.
void	setAttenuationCoefficient(float value) Sets the value of the AttenuationCoefficient attribute.
float	getAttenuationCoefficient() Returns the value of the AttenuationCoefficient attribute.
void	resetAttenuationCoefficient() Resets the AttenuationCoefficient attribute to an unset state.
boolean	hasAttenuationCoefficient() Checks whether the AttenuationCoefficient attribute is present.
void	setDiameter(float value, boolean validate) Sets the value of the Diameter attribute.
void	setDiameter(float value) Sets the value of the Diameter attribute.
float	getDiameter() Returns the value of the Diameter attribute.
void	resetDiameter() Resets the Diameter attribute to an unset state.
boolean	hasDiameter() Checks whether the Diameter attribute is present.
void	setDiameterUnit(UnitsLength_Type value, boolean validate) Sets the value of the DiameterUnit attribute.
void	setDiameterUnit(UnitsLength_Type value) Sets the value of the DiameterUnit attribute.
UnitsLength_Type	getDiameterUnit() Returns the value of the DiameterUnit attribute.
void	resetDiameterUnit() Resets the DiameterUnit attribute to an unset state.
boolean	hasDiameterUnit() Checks whether the optional DiameterUnit 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.
void	setThicknessUnit(UnitsLength_Type value, boolean validate) Sets the value of the ThicknessUnit attribute.
void	setThicknessUnit(UnitsLength_Type value) Sets the value of the ThicknessUnit attribute.
UnitsLength_Type	getThicknessUnit() Returns the value of the ThicknessUnit attribute.
void	resetThicknessUnit() Resets the ThicknessUnit attribute to an unset state.
boolean	hasThicknessUnit() Checks whether the optional ThicknessUnit attribute is present.
void	setAngleOfIncidence(float value, boolean validate) Sets the value of the AngleOfIncidence attribute.
void	setAngleOfIncidence(float value) Sets the value of the AngleOfIncidence attribute.
float	getAngleOfIncidence() Returns the value of the AngleOfIncidence attribute.
void	resetAngleOfIncidence() Resets the AngleOfIncidence attribute to an unset state.
boolean	hasAngleOfIncidence() Checks whether the AngleOfIncidence attribute is present.
void	setAngleOfIncidenceUnit(UnitsAngle_Type value, boolean validate) Sets the value of the AngleOfIncidenceUnit attribute.
void	setAngleOfIncidenceUnit(UnitsAngle_Type value) Sets the value of the AngleOfIncidenceUnit attribute.
UnitsAngle_Type	getAngleOfIncidenceUnit() Returns the value of the AngleOfIncidenceUnit attribute.
void	resetAngleOfIncidenceUnit() Resets the AngleOfIncidenceUnit attribute to an unset state.
boolean	hasAngleOfIncidenceUnit() Checks whether the optional AngleOfIncidenceUnit attribute is present.
void	setPolarization(FilterPolarizationType_Type value, boolean validate) Sets the value of the Polarization attribute.
void	setPolarization(FilterPolarizationType_Type value) Sets the value of the Polarization attribute.
FilterPolarizationType_Type	getPolarization() Returns the value of the Polarization attribute.
void	resetPolarization() Resets the Polarization attribute to an unset state.
boolean	hasPolarization() Checks whether the optional Polarization attribute is present.
void	setTransmittanceRange_List(TransmittanceRangeVector value, boolean validate) Sets the list of TransmittanceRange elements.
void	setTransmittanceRange_List(TransmittanceRangeVector value) Sets the list of TransmittanceRange elements.
TransmittanceRangeVector	getTransmittanceRange_List() Returns the list of TransmittanceRange elements.
void	addToTransmittanceRange_List(TransmittanceRange value, boolean validate) Adds a new TransmittanceRange element to this object.
void	addToTransmittanceRange_List(TransmittanceRange value) Adds a new TransmittanceRange element to this object.
void	clearTransmittanceRange_List() Clear the list of TransmittanceRange.
void	setTransmittanceProfileFile_List(TransmittanceProfileFileVector value, boolean validate) Sets the list of TransmittanceProfileFile elements.
void	setTransmittanceProfileFile_List(TransmittanceProfileFileVector value) Sets the list of TransmittanceProfileFile elements.
TransmittanceProfileFileVector	getTransmittanceProfileFile_List() Returns the list of TransmittanceProfileFile elements.
void	addToTransmittanceProfileFile_List(TransmittanceProfileFile value, boolean validate) Adds a new TransmittanceProfileFile element to this object.
void	addToTransmittanceProfileFile_List(TransmittanceProfileFile value) Adds a new TransmittanceProfileFile element to this object.
void	clearTransmittanceProfileFile_List() Clear the list of TransmittanceProfileFile.
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.Filter_Type

	Name
	Filter_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.ExcitationFilter;

Represents the XML element ExcitationFilter.

An optical Filter is a device designed to selectively control the Wavelengths, color temperature, vibration direction, and/or intensity of the radiation which it transmits or reflects. This element refers to an Excitation Filter whose purpose is to selectively attenuate the Light that is utilized to Excite the Sample depending on Wavelength. This element can be associated with an optional Filter Holder.

Public Functions Documentation¶

function delete¶

function ExcitationFilter¶

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.Filter_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.Filter_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.Filter_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.Filter_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.Filter_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.Filter_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.Filter_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.Filter_Type.toXmlFile

function 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.Filter_Type.toXmlString

function toXmlString¶

function __internal_create¶

function fromBase¶

public static ExcitationFilter fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a ExcitationFilter.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.Filter_Type.fromBase

com.inscoper.nbo.ExcitationFilter¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function ExcitationFilter¶

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

function fromBase¶

Protected Functions Documentation¶

function ExcitationFilter¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶