Qudi
Public Member Functions | Public Attributes | List of all members
process_dummy.ProcessDummy Class Reference

Methods to control slow laser switching devices. More...

Inheritance diagram for process_dummy.ProcessDummy:
Inheritance graph
[legend]
Collaboration diagram for process_dummy.ProcessDummy:
Collaboration graph
[legend]

Public Member Functions

def on_activate (self)
 Activate module.
 
def on_deactivate (self)
 Deactivate module.
 
def getProcessValue (self)
 Process value, here temperature. More...
 
def getProcessUnit (self)
 Process unit, here kelvin. More...
 
def setControlValue (self, value)
 Set control value, here heating power. More...
 
def getControlValue (self)
 Get current control value, here heating power. More...
 
def getControlUnit (self)
 Get unit of control value. More...
 
def getControlLimits (self)
 Get minimum and maximum of control value. More...
 
def metalHeatCapacity (self, T)
 Calculate heat capacity of copper at given temperature. More...
 
- Public Member Functions inherited from core.module.BaseMixin
def __init__ (self, manager, name, config=None, callbacks=None, kwargs)
 Initialise Base class object and set up its state machine. More...
 
def log (self)
 Returns a logger object.
 
def is_module_threaded (self)
 Returns whether the module shall be started in a thread.
 
def on_activate (self)
 Method called when module is activated. More...
 
def on_deactivate (self)
 Method called when module is deactivated. More...
 
def getStatusVariables (self)
 Return a dict of variable names and their content representing the module state for saving. More...
 
def setStatusVariables (self, variableDict)
 Give a module a dict of variable names and their content representing the module state. More...
 
def getConfiguration (self)
 Return the configration dictionary for this module. More...
 
def get_connector (self, connector_name)
 Return module connected to the given named connector. More...
 
- Public Member Functions inherited from core.module.ModuleMeta
def __new__ (cls, name, bases, attrs)
 Collect declared Connectors, ConfigOptions and StatusVars into dictionaries. More...
 

Public Attributes

 temperature
 
 pwmpower
 
 recalctimer
 
- Public Attributes inherited from core.module.BaseMixin
 module_state
 
 connectors
 

Detailed Description

Methods to control slow laser switching devices.

Example config for copy-paste:

process_dummy: module 'process_dummy.ProcessDummy'

Member Function Documentation

◆ getControlLimits()

def process_dummy.ProcessDummy.getControlLimits (   self)

Get minimum and maximum of control value.

Returns
tuple(float, float): minimum and maximum of control value

◆ getControlUnit()

def process_dummy.ProcessDummy.getControlUnit (   self)

Get unit of control value.

Returns
tuple(str): short and text unit of control value

◆ getControlValue()

def process_dummy.ProcessDummy.getControlValue (   self)

Get current control value, here heating power.

Returns
float: current control value

◆ getProcessUnit()

def process_dummy.ProcessDummy.getProcessUnit (   self)

Process unit, here kelvin.

Returns
float: process unit

◆ getProcessValue()

def process_dummy.ProcessDummy.getProcessValue (   self)

Process value, here temperature.

Returns
float: process value

◆ metalHeatCapacity()

def process_dummy.ProcessDummy.metalHeatCapacity (   self,
  T 
)

Calculate heat capacity of copper at given temperature.

Parameters
floatT: temperature at which to calculate heat capacity
Returns
float: hrat capacity at temperature T

◆ setControlValue()

def process_dummy.ProcessDummy.setControlValue (   self,
  value 
)

Set control value, here heating power.

Parameters
flaotvalue: control value

The documentation for this class was generated from the following file: