DarkFieldStop

Bases: OpticalAperture_Type

Represents the XML element DarkFieldStop.

This element refers to a central circular stop (i.e., opaque disk) usually used in dark-field microscopy and placed in the front focal Plane of a Condenser to occlude all the direct light which would fall within the aperture of the objective.

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
DarkFieldStop	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

setCenterStopDiameter(value, validate=True)

Sets the value of the CenterStopDiameter attribute.

This field captures the physical diameter of the central disk of this Dark Field Stop.

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

getCenterStopDiameter()

Returns the value of the CenterStopDiameter attribute.

This field captures the physical diameter of the central disk of this Dark Field Stop.

Returns:

Type	Description
float	The value of the attribute

resetCenterStopDiameter()

Resets the CenterStopDiameter attribute to an unset state.

This field captures the physical diameter of the central disk of this Dark Field Stop.

hasCenterStopDiameter()

Checks whether the CenterStopDiameter attribute is present.

This field captures the physical diameter of the central disk of this Dark Field Stop.

Returns:

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

setCenterStopDiameterUnit(value, validate=True)

Sets the value of the CenterStopDiameterUnit attribute.

No description available in the XSD standard.

Parameters:

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

getCenterStopDiameterUnit()

Returns the value of the CenterStopDiameterUnit attribute.

No description available in the XSD standard.

Returns:

Type	Description
UnitsLength_Type	The value of the attribute

resetCenterStopDiameterUnit()

Resets the CenterStopDiameterUnit attribute to an unset state.

No description available in the XSD standard.

hasCenterStopDiameterUnit()

Checks whether the optional CenterStopDiameterUnit attribute is present.

No description available in the XSD standard.

Returns:

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