NeutralDensityFilter

Bases: Filter_Type

Represents the XML element NeutralDensityFilter.

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 optical Filter whose purpose is to attenuate the intensity of the transmitted Light independent of the Wavelength.

fromBase(base) staticmethod

Cast a NBOBaseClass to a CMOS.

Parameters:

Name	Type	Description	Default
base	NBOBaseClass	The base class to cast	required

Returns:

Type	Description
NeutralDensityFilter	The casted element, or nullptr if the cast fails

getTypeName()

Returns the class type name.

Returns:

Type	Description
string	The class type name

getXMLName()

Returns the XML element name corresponding to this class.

Returns:

Type	Description
string	The XML element name

getNBOType()

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
int	The NBO Type value

getChildren()

Returns a list of all classes derived from this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of derived classes

getSubElements()

Returns a list of all child elements contained in this class.

Returns:

Type	Description
List[NBOBaseClass]	The list of child classes

fromJsonFile(path, validate=True)

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
path	string	The path to the JSON file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromJsonString(json_string, validate=True)

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
json_string	string	The JSON content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlFile(path, validate=True)

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
path	string	The path to the XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

fromXmlString(xml_string, validate=True)

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
xml_string	string	The XML content as a string	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlFile(filename, validate=True)

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
filename	string	The path to the output XML file	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

toXmlString(validate=True)

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

Returns:

Type	Description
string	A string containing the XML representation of this object

setNDType(value, validate=True)

Sets the value of the NDType attribute.

This field refers to the general category of this Neutral Density Filter. Neutral Density Filters come in two general types. Those made of darkened glass that absorb light and those coated with a metal film that reflect light.

Parameters:

Name	Type	Description	Default
value	NDTYPE_Type	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getNDType()

Returns the value of the NDType attribute.

This field refers to the general category of this Neutral Density Filter. Neutral Density Filters come in two general types. Those made of darkened glass that absorb light and those coated with a metal film that reflect light.

Returns:

Type	Description
NDTYPE_Type	The value of the attribute

resetNDType()

Resets the NDType attribute to an unset state.

This field refers to the general category of this Neutral Density Filter. Neutral Density Filters come in two general types. Those made of darkened glass that absorb light and those coated with a metal film that reflect light.

hasNDType()

Checks whether the optional NDType attribute is present.

This field refers to the general category of this Neutral Density Filter. Neutral Density Filters come in two general types. Those made of darkened glass that absorb light and those coated with a metal film that reflect light.

Returns:

Type	Description
boolean	true if the optional attribute has been set, false otherwise

setOpticalDensity(value, validate=True)

Sets the value of the OpticalDensity attribute.

This field measures the absolute value of the logarithm of base 10 of the power transmission factor. For example, an optical density of 3 means an attenuation of optical powers by the factor 10^3

Parameters:

Name	Type	Description	Default
value	float	The value to set	required
validate	(boolean, optional)	If true, validates constraints on value. Default is true.	True

getOpticalDensity()

Returns the value of the OpticalDensity attribute.

This field measures the absolute value of the logarithm of base 10 of the power transmission factor. For example, an optical density of 3 means an attenuation of optical powers by the factor 10^3

Returns:

Type	Description
float	The value of the attribute

resetOpticalDensity()

Resets the OpticalDensity attribute to an unset state.

This field measures the absolute value of the logarithm of base 10 of the power transmission factor. For example, an optical density of 3 means an attenuation of optical powers by the factor 10^3

hasOpticalDensity()

Checks whether the OpticalDensity attribute is present.

This field measures the absolute value of the logarithm of base 10 of the power transmission factor. For example, an optical density of 3 means an attenuation of optical powers by the factor 10^3

Returns:

Type	Description
boolean	true if the attribute has been set, false otherwise