com.inscoper.nbo.FilterSet¶

Represents the XML element FilterSet. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	FilterSet()
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(FilterSetID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(FilterSetID_Type value) Sets the value of the ID attribute.
FilterSetID_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	setExcitationFilterRef(ExcitationFilterRef value, boolean validate) Sets the value of the ExcitationFilterRef element.
void	setExcitationFilterRef(ExcitationFilterRef value) Sets the value of the ExcitationFilterRef element.
ExcitationFilterRef	getExcitationFilterRef() Returns the value of the ExcitationFilterRef element.
void	resetExcitationFilterRef() Resets the ExcitationFilterRef element to an unset state.
boolean	hasExcitationFilterRef() Checks whether the optional ExcitationFilterRef element is present.
void	setStandardDichroicRef(StandardDichroicRef value, boolean validate) Sets the value of the StandardDichroicRef element.
void	setStandardDichroicRef(StandardDichroicRef value) Sets the value of the StandardDichroicRef element.
StandardDichroicRef	getStandardDichroicRef() Returns the value of the StandardDichroicRef element.
void	resetStandardDichroicRef() Resets the StandardDichroicRef element to an unset state.
boolean	hasStandardDichroicRef() Checks whether the optional StandardDichroicRef element is present.
void	setEmissionFilterRef(EmissionFilterRef value, boolean validate) Sets the value of the EmissionFilterRef element.
void	setEmissionFilterRef(EmissionFilterRef value) Sets the value of the EmissionFilterRef element.
EmissionFilterRef	getEmissionFilterRef() Returns the value of the EmissionFilterRef element.
void	resetEmissionFilterRef() Resets the EmissionFilterRef element to an unset state.
boolean	hasEmissionFilterRef() Checks whether the optional EmissionFilterRef element 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.
FilterSet	__internal_create(long cPtr, boolean own)
FilterSet	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a FilterSet.

Protected Functions¶

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

Additional inherited members¶

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.FilterSet;

Represents the XML element FilterSet.

This element represents a FilterSet that was used for the acquisition of this Channel. A Filter Set is typically composed of one Excitation Filter, one Emission Filter and a Dichroic. They might either be pre-assembled by the Manufacturer and purchased as a whole or they can be custom assembled on site depending on the needs of the user.

Public Functions Documentation¶

function delete¶

function FilterSet¶

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.NBOBaseClass.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.

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.

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

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.

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

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

function toXmlString¶

function setID¶

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

A Unique Identifier for this component.

function setID¶

function getID¶

function resetID¶

function hasID¶

function setName¶

public void setName(
    Denomination_Type value,
    boolean validate
)

Sets the value of the Name attribute.

Parameters:

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

A user-defined Name for this component.

function setName¶

function getName¶

function resetName¶

function hasName¶

function setExcitationFilterRef¶

public void setExcitationFilterRef(
    ExcitationFilterRef value,
    boolean validate
)

Sets the value of the ExcitationFilterRef element.

Parameters:

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

No description available in the XSD standard.

function setExcitationFilterRef¶

public void setExcitationFilterRef(
    ExcitationFilterRef value
)

Sets the value of the ExcitationFilterRef element.

Parameters:

value The value to set

No description available in the XSD standard.

function getExcitationFilterRef¶

function resetExcitationFilterRef¶

function hasExcitationFilterRef¶

public boolean hasExcitationFilterRef()

Checks whether the optional ExcitationFilterRef element is present.

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

No description available in the XSD standard.

function setStandardDichroicRef¶

public void setStandardDichroicRef(
    StandardDichroicRef value,
    boolean validate
)

Sets the value of the StandardDichroicRef element.

Parameters:

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

This refers to an available dichroic mirror, which is part of this filter set.

function setStandardDichroicRef¶

public void setStandardDichroicRef(
    StandardDichroicRef value
)

Sets the value of the StandardDichroicRef element.

Parameters:

value The value to set

This refers to an available dichroic mirror, which is part of this filter set.

function getStandardDichroicRef¶

public StandardDichroicRef getStandardDichroicRef()

Returns the value of the StandardDichroicRef element.

Return: The value of the element

This refers to an available dichroic mirror, which is part of this filter set.

function resetStandardDichroicRef¶

function hasStandardDichroicRef¶

public boolean hasStandardDichroicRef()

Checks whether the optional StandardDichroicRef element is present.

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

This refers to an available dichroic mirror, which is part of this filter set.

function setEmissionFilterRef¶

public void setEmissionFilterRef(
    EmissionFilterRef value,
    boolean validate
)

Sets the value of the EmissionFilterRef element.

Parameters:

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

No description available in the XSD standard.

function setEmissionFilterRef¶

public void setEmissionFilterRef(
    EmissionFilterRef value
)

Sets the value of the EmissionFilterRef element.

Parameters:

value The value to set

No description available in the XSD standard.

function getEmissionFilterRef¶

function resetEmissionFilterRef¶

function hasEmissionFilterRef¶

public boolean hasEmissionFilterRef()

Checks whether the optional EmissionFilterRef element is present.

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

No description available in the XSD standard.

function setAnnotationRef¶

public void setAnnotationRef(
    AnnotationRef value,
    boolean validate
)

Sets the value of the AnnotationRef element.

Parameters:

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

No description available in the XSD standard.

function setAnnotationRef¶

function getAnnotationRef¶

function resetAnnotationRef¶

function hasAnnotationRef¶

public boolean hasAnnotationRef()

com.inscoper.nbo.FilterSet¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function FilterSet¶

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

function setID¶

function getID¶

function resetID¶

function hasID¶

function setName¶

function setName¶

function getName¶

function resetName¶

function hasName¶

function setExcitationFilterRef¶

function setExcitationFilterRef¶

function getExcitationFilterRef¶

function resetExcitationFilterRef¶

function hasExcitationFilterRef¶

function setStandardDichroicRef¶

function setStandardDichroicRef¶

function getStandardDichroicRef¶

function resetStandardDichroicRef¶

function hasStandardDichroicRef¶

function setEmissionFilterRef¶

function setEmissionFilterRef¶

function getEmissionFilterRef¶

function resetEmissionFilterRef¶

function hasEmissionFilterRef¶

function setAnnotationRef¶

function setAnnotationRef¶

function getAnnotationRef¶

function resetAnnotationRef¶

function hasAnnotationRef¶

function __internal_create¶

function fromBase¶

Protected Functions Documentation¶

function FilterSet¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶