com.inscoper.nbo.DiffractionGrating¶

Represents the XML element DiffractionGrating. More...

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

Public Functions¶

	Name
synchronized void	delete()
	DiffractionGrating()
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	setPeriod(float value, boolean validate) Sets the value of the Period attribute.
void	setPeriod(float value) Sets the value of the Period attribute.
float	getPeriod() Returns the value of the Period attribute.
void	resetPeriod() Resets the Period attribute to an unset state.
boolean	hasPeriod() Checks whether the Period attribute is present.
void	setPeriodUnit(UnitsLength_Type value, boolean validate) Sets the value of the PeriodUnit attribute.
void	setPeriodUnit(UnitsLength_Type value) Sets the value of the PeriodUnit attribute.
UnitsLength_Type	getPeriodUnit() Returns the value of the PeriodUnit attribute.
void	resetPeriodUnit() Resets the PeriodUnit attribute to an unset state.
boolean	hasPeriodUnit() Checks whether the optional PeriodUnit attribute is present.
void	setSpatialFrequency(float value, boolean validate) Sets the value of the SpatialFrequency attribute.
void	setSpatialFrequency(float value) Sets the value of the SpatialFrequency attribute.
float	getSpatialFrequency() Returns the value of the SpatialFrequency attribute.
void	resetSpatialFrequency() Resets the SpatialFrequency attribute to an unset state.
boolean	hasSpatialFrequency() Checks whether the SpatialFrequency attribute is present.
void	setTransmittive(boolean value, boolean validate) Sets the value of the Transmittive attribute.
void	setTransmittive(boolean value) Sets the value of the Transmittive attribute.
boolean	getTransmittive() Returns the value of the Transmittive attribute.
void	resetTransmittive() Resets the Transmittive attribute to an unset state.
boolean	hasTransmittive() Checks whether the Transmittive attribute is present.
void	setModulationMode(ModulationModeList_Type value, boolean validate) Sets the value of the ModulationMode attribute.
void	setModulationMode(ModulationModeList_Type value) Sets the value of the ModulationMode attribute.
ModulationModeList_Type	getModulationMode() Returns the value of the ModulationMode attribute.
void	resetModulationMode() Resets the ModulationMode attribute to an unset state.
boolean	hasModulationMode() Checks whether the optional ModulationMode attribute is present.
void	setRonchi(boolean value, boolean validate) Sets the value of the Ronchi attribute.
void	setRonchi(boolean value) Sets the value of the Ronchi attribute.
boolean	getRonchi() Returns the value of the Ronchi attribute.
void	resetRonchi() Resets the Ronchi attribute to an unset state.
boolean	hasRonchi() Checks whether the Ronchi attribute is present.
DiffractionGrating	__internal_create(long cPtr, boolean own)
DiffractionGrating	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

Protected Functions¶

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

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.OpticalAperture_Type

	Name
	OpticalAperture_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	setOpticsHolderPosition(String value, boolean validate) Sets the value of the OpticsHolderPosition attribute.
void	setOpticsHolderPosition(String value) Sets the value of the OpticsHolderPosition attribute.
String	getOpticsHolderPosition() Returns the value of the OpticsHolderPosition attribute.
void	resetOpticsHolderPosition() Resets the OpticsHolderPosition attribute to an unset state.
boolean	hasOpticsHolderPosition() Checks whether the OpticsHolderPosition attribute is present.
void	setOuterDiameter(float value, boolean validate) Sets the value of the OuterDiameter attribute.
void	setOuterDiameter(float value) Sets the value of the OuterDiameter attribute.
float	getOuterDiameter() Returns the value of the OuterDiameter attribute.
void	resetOuterDiameter() Resets the OuterDiameter attribute to an unset state.
boolean	hasOuterDiameter() Checks whether the OuterDiameter attribute is present.
void	setOuterDiameterUnit(UnitsLength_Type value, boolean validate) Sets the value of the OuterDiameterUnit attribute.
void	setOuterDiameterUnit(UnitsLength_Type value) Sets the value of the OuterDiameterUnit attribute.
UnitsLength_Type	getOuterDiameterUnit() Returns the value of the OuterDiameterUnit attribute.
void	resetOuterDiameterUnit() Resets the OuterDiameterUnit attribute to an unset state.
boolean	hasOuterDiameterUnit() Checks whether the optional OuterDiameterUnit 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.
StringSet	getOpticsHolderPositionAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.OpticalAperture_Type

	Name
	OpticalAperture_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.DiffractionGrating;

Represents the XML element DiffractionGrating.

A Diffraction Grating is an optical component with a periodic structure that splits and diffracts light into several beams travelling in different directions.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.OpticalAperture_Type.delete

function DiffractionGrating¶

public DiffractionGrating()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.OpticalAperture_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.OpticalAperture_Type.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_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.OpticalAperture_Type.toXmlString

function setPeriod¶

public void setPeriod(
    float value,
    boolean validate
)

Sets the value of the Period attribute.

Parameters:

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

This field records the spacing between the centers of two adjacent slits (d).

function setPeriod¶

public void setPeriod(
    float value
)

Sets the value of the Period attribute.

Parameters:

value The value to set

This field records the spacing between the centers of two adjacent slits (d).

function getPeriod¶

public float getPeriod()

Returns the value of the Period attribute.

Return: The value of the attribute

This field records the spacing between the centers of two adjacent slits (d).

function resetPeriod¶

public void resetPeriod()

Resets the Period attribute to an unset state.

This field records the spacing between the centers of two adjacent slits (d).

function hasPeriod¶

public boolean hasPeriod()

Checks whether the Period attribute is present.

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

This field records the spacing between the centers of two adjacent slits (d).

function setPeriodUnit¶

public void setPeriodUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the PeriodUnit 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 setPeriodUnit¶

public void setPeriodUnit(
    UnitsLength_Type value
)

Sets the value of the PeriodUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getPeriodUnit¶

public UnitsLength_Type getPeriodUnit()

Returns the value of the PeriodUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetPeriodUnit¶

public void resetPeriodUnit()

Resets the PeriodUnit attribute to an unset state.

No description available in the XSD standard.

function hasPeriodUnit¶

public boolean hasPeriodUnit()

Checks whether the optional PeriodUnit attribute is present.

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

No description available in the XSD standard.

function setSpatialFrequency¶

public void setSpatialFrequency(
    float value,
    boolean validate
)

Sets the value of the SpatialFrequency attribute.

Parameters:

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

This field records the number of slits (or lines) per unit length (1/d). Typically it is measured in terms of number of slits per millimiter.

function setSpatialFrequency¶

public void setSpatialFrequency(
    float value
)

Sets the value of the SpatialFrequency attribute.

Parameters:

value The value to set

This field records the number of slits (or lines) per unit length (1/d). Typically it is measured in terms of number of slits per millimiter.

function getSpatialFrequency¶

public float getSpatialFrequency()

Returns the value of the SpatialFrequency attribute.

Return: The value of the attribute

This field records the number of slits (or lines) per unit length (1/d). Typically it is measured in terms of number of slits per millimiter.

function resetSpatialFrequency¶

public void resetSpatialFrequency()

Resets the SpatialFrequency attribute to an unset state.

This field records the number of slits (or lines) per unit length (1/d). Typically it is measured in terms of number of slits per millimiter.

function hasSpatialFrequency¶

public boolean hasSpatialFrequency()

Checks whether the SpatialFrequency attribute is present.

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

This field records the number of slits (or lines) per unit length (1/d). Typically it is measured in terms of number of slits per millimiter.

function setTransmittive¶

public void setTransmittive(
    boolean value,
    boolean validate
)

Sets the value of the Transmittive attribute.

Parameters:

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

This field records whether the periodic fine structure of this Diffraction Grating is Transmissive (True) and therefore refracts light, or is Reflective (False) and therefore reflects it.

function setTransmittive¶

public void setTransmittive(
    boolean value
)

Sets the value of the Transmittive attribute.

Parameters:

value The value to set

This field records whether the periodic fine structure of this Diffraction Grating is Transmissive (True) and therefore refracts light, or is Reflective (False) and therefore reflects it.

function getTransmittive¶

public boolean getTransmittive()

Returns the value of the Transmittive attribute.

Return: The value of the attribute

This field records whether the periodic fine structure of this Diffraction Grating is Transmissive (True) and therefore refracts light, or is Reflective (False) and therefore reflects it.

function resetTransmittive¶

public void resetTransmittive()

Resets the Transmittive attribute to an unset state.

This field records whether the periodic fine structure of this Diffraction Grating is Transmissive (True) and therefore refracts light, or is Reflective (False) and therefore reflects it.

function hasTransmittive¶

public boolean hasTransmittive()

Checks whether the Transmittive attribute is present.

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

This field records whether the periodic fine structure of this Diffraction Grating is Transmissive (True) and therefore refracts light, or is Reflective (False) and therefore reflects it.

function setModulationMode¶

public void setModulationMode(
    ModulationModeList_Type value,
    boolean validate
)

Sets the value of the ModulationMode attribute.

Parameters:

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

This field indicates what aspect of the light beam is modulated by this device.

function setModulationMode¶

public void setModulationMode(
    ModulationModeList_Type value
)

Sets the value of the ModulationMode attribute.

Parameters:

value The value to set

This field indicates what aspect of the light beam is modulated by this device.

function getModulationMode¶

public ModulationModeList_Type getModulationMode()

Returns the value of the ModulationMode attribute.

Return: The value of the attribute

This field indicates what aspect of the light beam is modulated by this device.

function resetModulationMode¶

public void resetModulationMode()

Resets the ModulationMode attribute to an unset state.

This field indicates what aspect of the light beam is modulated by this device.

function hasModulationMode¶

public boolean hasModulationMode()

Checks whether the optional ModulationMode attribute is present.

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

This field indicates what aspect of the light beam is modulated by this device.

function setRonchi¶

public void setRonchi(
    boolean value,
    boolean validate
)

Sets the value of the Ronchi attribute.

Parameters:

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

This field records whether this Diffraction Grating has a square wave profile, as defined by Ronchi (True) or a sine wave profile (False).

function setRonchi¶

public void setRonchi(
    boolean value
)

Sets the value of the Ronchi attribute.

Parameters:

value The value to set

This field records whether this Diffraction Grating has a square wave profile, as defined by Ronchi (True) or a sine wave profile (False).

function getRonchi¶

public boolean getRonchi()

Returns the value of the Ronchi attribute.

Return: The value of the attribute

This field records whether this Diffraction Grating has a square wave profile, as defined by Ronchi (True) or a sine wave profile (False).

function resetRonchi¶

public void resetRonchi()

Resets the Ronchi attribute to an unset state.

This field records whether this Diffraction Grating has a square wave profile, as defined by Ronchi (True) or a sine wave profile (False).

function hasRonchi¶

public boolean hasRonchi()

Checks whether the Ronchi attribute is present.

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

This field records whether this Diffraction Grating has a square wave profile, as defined by Ronchi (True) or a sine wave profile (False).

function __internal_create¶

public static DiffractionGrating __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.OpticalAperture_Type.__internal_create

function fromBase¶

public static DiffractionGrating fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

base The base class to cast

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

Reimplements: com.inscoper.nbo.OpticalAperture_Type.fromBase

Protected Functions Documentation¶

function DiffractionGrating¶

protected DiffractionGrating(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.OpticalAperture_Type.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.OpticalAperture_Type.finalize

function getCPtr¶

protected static long getCPtr(
    DiffractionGrating obj
)

Updated on 2026-06-22 at 17:06:24 +0200