Bases: LightSourceCoupling_Type
Represents the XML element FreeBeam.
A Free Beam coupling between the Light Source and the Microscope Stand consists of either a direct mount or an optical path that directs light across free space to the back of the Microscope Stand.
fromBase ( base )
staticmethod
fromJsonFile ( path , validate = True )
fromJsonString ( json_string , validate = True )
fromXmlFile ( path , validate = True )
fromXmlString ( xml_string , validate = True )
toXmlFile ( filename , validate = True )
toXmlString ( validate = True )
setDirectMount ( value , validate = True )
Sets the value of the DirectMount attribute.
Whether light traveling via this Light Source Coupling device from the Light Source to the Microscope Stand travels via a direct mount attached to the Microscope Stand (True), or across an optical path through the air (False).
Parameters:
Name
Type
Description
Default
value
boolean
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getDirectMount ()
Returns the value of the DirectMount attribute.
Whether light traveling via this Light Source Coupling device from the Light Source to the Microscope Stand travels via a direct mount attached to the Microscope Stand (True), or across an optical path through the air (False).
Returns:
Type
Description
boolean
The value of the attribute
resetDirectMount ()
Resets the DirectMount attribute to an unset state.
Whether light traveling via this Light Source Coupling device from the Light Source to the Microscope Stand travels via a direct mount attached to the Microscope Stand (True), or across an optical path through the air (False).
hasDirectMount ()
Checks whether the DirectMount attribute is present.
Whether light traveling via this Light Source Coupling device from the Light Source to the Microscope Stand travels via a direct mount attached to the Microscope Stand (True), or across an optical path through the air (False).
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
setMountType ( value , validate = True )
Sets the value of the MountType attribute.
In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.
Parameters:
Name
Type
Description
Default
value
string
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
getMountType ()
Returns the value of the MountType attribute.
In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.
Returns:
Type
Description
string
The value of the attribute
resetMountType ()
Resets the MountType attribute to an unset state.
In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.
hasMountType ()
Checks whether the MountType attribute is present.
In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.
Returns:
Type
Description
boolean
true if the attribute has been set, false otherwise
getMountTypeAllowedValues ()
staticmethod
Returns the allowed values for this attribut.
In case the DirectMount field is True, this field records the type of Direct Mount utilized to couple the Light Source to this Microscope Stand.
Returns:
Type
Description
std::set< str,std::less< str >,std::allocator< str > >
The list of allowed values