com.inscoper.nbo.LEDModule¶

Represents the XML element LEDModule. More...

Inherits from com.inscoper.nbo.IlluminationWavelengthRangeType_Type, com.inscoper.nbo.WavelengthRangeType_Type, com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	LEDModule()
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	setProjectionAngle(float value, boolean validate) Sets the value of the ProjectionAngle attribute.
void	setProjectionAngle(float value) Sets the value of the ProjectionAngle attribute.
float	getProjectionAngle() Returns the value of the ProjectionAngle attribute.
void	resetProjectionAngle() Resets the ProjectionAngle attribute to an unset state.
boolean	hasProjectionAngle() Checks whether the ProjectionAngle attribute is present.
void	setProjectionAngleUnit(UnitsAngle_Type value, boolean validate) Sets the value of the ProjectionAngleUnit attribute.
void	setProjectionAngleUnit(UnitsAngle_Type value) Sets the value of the ProjectionAngleUnit attribute.
UnitsAngle_Type	getProjectionAngleUnit() Returns the value of the ProjectionAngleUnit attribute.
void	resetProjectionAngleUnit() Resets the ProjectionAngleUnit attribute to an unset state.
boolean	hasProjectionAngleUnit() Checks whether the optional ProjectionAngleUnit attribute is present.
LEDModule	__internal_create(long cPtr, boolean own)
LEDModule	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a LEDModule.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.IlluminationWavelengthRangeType_Type

	Name
	IlluminationWavelengthRangeType_Type()
void	setIlluminationPower(float value, boolean validate) Sets the value of the IlluminationPower attribute.
void	setIlluminationPower(float value) Sets the value of the IlluminationPower attribute.
float	getIlluminationPower() Returns the value of the IlluminationPower attribute.
void	resetIlluminationPower() Resets the IlluminationPower attribute to an unset state.
boolean	hasIlluminationPower() Checks whether the IlluminationPower attribute is present.
void	setIlluminationPowerUnit(UnitsPower_Type value, boolean validate) Sets the value of the IlluminationPowerUnit attribute.
void	setIlluminationPowerUnit(UnitsPower_Type value) Sets the value of the IlluminationPowerUnit attribute.
UnitsPower_Type	getIlluminationPowerUnit() Returns the value of the IlluminationPowerUnit attribute.
void	resetIlluminationPowerUnit() Resets the IlluminationPowerUnit attribute to an unset state.
boolean	hasIlluminationPowerUnit() Checks whether the optional IlluminationPowerUnit attribute is present.

Protected Functions inherited from com.inscoper.nbo.IlluminationWavelengthRangeType_Type

	Name
	IlluminationWavelengthRangeType_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.WavelengthRangeType_Type

	Name
	WavelengthRangeType_Type()
void	setPeakWavelength(float value, boolean validate) Sets the value of the PeakWavelength attribute.
void	setPeakWavelength(float value) Sets the value of the PeakWavelength attribute.
float	getPeakWavelength() Returns the value of the PeakWavelength attribute.
void	resetPeakWavelength() Resets the PeakWavelength attribute to an unset state.
boolean	hasPeakWavelength() Checks whether the PeakWavelength attribute is present.
void	setPeakWavelengthUnit(UnitsLength_Type value, boolean validate) Sets the value of the PeakWavelengthUnit attribute.
void	setPeakWavelengthUnit(UnitsLength_Type value) Sets the value of the PeakWavelengthUnit attribute.
UnitsLength_Type	getPeakWavelengthUnit() Returns the value of the PeakWavelengthUnit attribute.
void	resetPeakWavelengthUnit() Resets the PeakWavelengthUnit attribute to an unset state.
boolean	hasPeakWavelengthUnit() Checks whether the optional PeakWavelengthUnit attribute is present.
void	setCutOn(PositiveFloat_Type value, boolean validate) Sets the value of the CutOn attribute.
void	setCutOn(PositiveFloat_Type value) Sets the value of the CutOn attribute.
PositiveFloat_Type	getCutOn() Returns the value of the CutOn attribute.
void	resetCutOn() Resets the CutOn attribute to an unset state.
boolean	hasCutOn() Checks whether the optional CutOn attribute is present.
void	setCutOnUnit(UnitsLength_Type value, boolean validate) Sets the value of the CutOnUnit attribute.
void	setCutOnUnit(UnitsLength_Type value) Sets the value of the CutOnUnit attribute.
UnitsLength_Type	getCutOnUnit() Returns the value of the CutOnUnit attribute.
void	resetCutOnUnit() Resets the CutOnUnit attribute to an unset state.
boolean	hasCutOnUnit() Checks whether the optional CutOnUnit attribute is present.
void	setCutOff(PositiveFloat_Type value, boolean validate) Sets the value of the CutOff attribute.
void	setCutOff(PositiveFloat_Type value) Sets the value of the CutOff attribute.
PositiveFloat_Type	getCutOff() Returns the value of the CutOff attribute.
void	resetCutOff() Resets the CutOff attribute to an unset state.
boolean	hasCutOff() Checks whether the optional CutOff attribute is present.
void	setCutOffUnit(UnitsLength_Type value, boolean validate) Sets the value of the CutOffUnit attribute.
void	setCutOffUnit(UnitsLength_Type value) Sets the value of the CutOffUnit attribute.
UnitsLength_Type	getCutOffUnit() Returns the value of the CutOffUnit attribute.
void	resetCutOffUnit() Resets the CutOffUnit attribute to an unset state.
boolean	hasCutOffUnit() Checks whether the optional CutOffUnit attribute is present.
void	setWavelengthProfileFile_List(WavelengthProfileFileVector value, boolean validate) Sets the list of WavelengthProfileFile elements.
void	setWavelengthProfileFile_List(WavelengthProfileFileVector value) Sets the list of WavelengthProfileFile elements.
WavelengthProfileFileVector	getWavelengthProfileFile_List() Returns the list of WavelengthProfileFile elements.
void	addToWavelengthProfileFile_List(WavelengthProfileFile value, boolean validate) Adds a new WavelengthProfileFile element to this object.
void	addToWavelengthProfileFile_List(WavelengthProfileFile value) Adds a new WavelengthProfileFile element to this object.
void	clearWavelengthProfileFile_List() Clear the list of WavelengthProfileFile.

Protected Functions inherited from com.inscoper.nbo.WavelengthRangeType_Type

	Name
	WavelengthRangeType_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.LEDModule;

Represents the XML element LEDModule.

A Light Emitting Diode (LED) Light Source is often composed of multiple modules each with its own wavelength characteristics. This element describes an individual LED module. Multiple of this elements may be used.

Public Functions Documentation¶

function delete¶

function LEDModule¶

function getTypeName¶

function getXMLName¶

function 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.IlluminationWavelengthRangeType_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.IlluminationWavelengthRangeType_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.IlluminationWavelengthRangeType_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.IlluminationWavelengthRangeType_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.IlluminationWavelengthRangeType_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.IlluminationWavelengthRangeType_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.IlluminationWavelengthRangeType_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.IlluminationWavelengthRangeType_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.IlluminationWavelengthRangeType_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.IlluminationWavelengthRangeType_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.IlluminationWavelengthRangeType_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.IlluminationWavelengthRangeType_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.IlluminationWavelengthRangeType_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.IlluminationWavelengthRangeType_Type.toXmlString

function setProjectionAngle¶

public void setProjectionAngle(
    float value,
    boolean validate
)

Sets the value of the ProjectionAngle attribute.

Parameters:

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

This field records the angle at which this LED Module projects the light beam.

function setProjectionAngle¶

public void setProjectionAngle(
    float value
)

Sets the value of the ProjectionAngle attribute.

Parameters:

value The value to set

This field records the angle at which this LED Module projects the light beam.

function getProjectionAngle¶

public float getProjectionAngle()

Returns the value of the ProjectionAngle attribute.

Return: The value of the attribute

This field records the angle at which this LED Module projects the light beam.

function resetProjectionAngle¶

function hasProjectionAngle¶

public boolean hasProjectionAngle()

Checks whether the ProjectionAngle attribute is present.

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

This field records the angle at which this LED Module projects the light beam.

function setProjectionAngleUnit¶

public void setProjectionAngleUnit(
    UnitsAngle_Type value,
    boolean validate
)

Sets the value of the ProjectionAngleUnit attribute.

Parameters:

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

No description available in the XSD standard.

function setProjectionAngleUnit¶

public void setProjectionAngleUnit(
    UnitsAngle_Type value
)

Sets the value of the ProjectionAngleUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getProjectionAngleUnit¶

function resetProjectionAngleUnit¶

function hasProjectionAngleUnit¶

public boolean hasProjectionAngleUnit()

Checks whether the optional ProjectionAngleUnit attribute is present.

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

No description available in the XSD standard.

function __internal_create¶

function fromBase¶

public static LEDModule fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a LEDModule.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.IlluminationWavelengthRangeType_Type.fromBase

com.inscoper.nbo.LEDModule¶

Public Functions¶

Protected Functions¶

Additional inherited members¶

Detailed Description¶

Public Functions Documentation¶

function delete¶

function LEDModule¶

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

function setProjectionAngle¶

function getProjectionAngle¶

function resetProjectionAngle¶

function hasProjectionAngle¶

function setProjectionAngleUnit¶

function setProjectionAngleUnit¶

function getProjectionAngleUnit¶

function resetProjectionAngleUnit¶

function hasProjectionAngleUnit¶

function __internal_create¶

function fromBase¶

Protected Functions Documentation¶

function LEDModule¶

function swigSetCMemOwn¶

function finalize¶

function getCPtr¶