piezo.piezo.DevsimPiezo Class Reference

Device Simulator class for the Standard Piezo Device. More...

Inheritance diagram for piezo.piezo.DevsimPiezo:

Public Member Functions
def	__init__ (self)
	Initialise the Piezo Device simulator class; set the members. More...
def	initialise (self)
	Initialise various parameters of the simulated device. More...
def	set_error_attribs (self, error_code)
	Set the "stat.nErrorCode"/"stat.sErrorText" node values. More...
def	set_rpc_error_attribs (self, rpc_error_code)
	Set the "stat.nRpcErrorCode"/"stat.sRpcErrorText" node values. More...
def	sim_thr_user (self)
	Simulation Thread managing the piezo status. More...
def	check_range_user (self, index, value)
	Check wether user value is within the AD converter range. More...
def	get_bits (self, index, user_value)
	Get the bits for a given user value. More...
def	get_pos (self, index, bit_value)
	Get the pos in user units for a given user value in bits. More...
def	reset_piezo_values (self)
	Reset piezo values. More...
def	data_change_handler (self, node, value, data)
	Invoked when subscribed "ctrl." and "stat." nodes change value. More...
def	RPC_Init (self, parent)
	Initiate the initialisation procedure. More...
def	RPC_Reset (self, parent)
	Reset the Piezo Device (bring it to NotOp/NotReady). More...
def	RPC_Enable (self, parent)
	Execute SM Enable operation. More...
def	RPC_Pos (self, parent)
	Execute SM Pos operation. More...
def	RPC_Auto (self, parent)
	Execute SM Auto operation. More...
def	RPC_Home (self, parent)
	Execute SM Auto operation. More...
def	RPC_MoveUser (self, parent, in_lrPos1, in_lrPos2, in_lrPos3)
	Execute MoveUser operation. More...
def	RPC_MoveBit (self, parent, in_nPos1, in_nPos2, in_nPos3)
	Execute MoveBits operation. More...
def	RPC_Disable (self, parent)
	Execute SM Disable operation. More...
def	RPC_Stop (self, parent)
	Execute SM Disable operation. More...

Public Attributes
	initialised
	sim_init_time

Static Public Attributes
string	CFG_TODO = "TODO"
	OPC UA Namespace Node IDs: More...
string	CTRL_TODO = "TODO"
string	STAT_COUNTER = "stat.nCycleCounter"

Detailed Description

Device Simulator class for the Standard Piezo Device.

Constructor & Destructor Documentation

__init__()

def piezo.piezo.DevsimPiezo.__init__

(

self

)

Initialise the Piezo Device simulator class; set the members.

Member Function Documentation

check_range_user()

def piezo.piezo.DevsimPiezo.check_range_user	(		self,
			index,
			value
	)

Check wether user value is within the AD converter range.

data_change_handler()

def piezo.piezo.DevsimPiezo.data_change_handler	(		self,
			node,
			value,
			data
	)

Invoked when subscribed "ctrl." and "stat." nodes change value.

get_bits()

def piezo.piezo.DevsimPiezo.get_bits	(		self,
			index,
			user_value
	)

Get the bits for a given user value.

get_pos()

def piezo.piezo.DevsimPiezo.get_pos	(		self,
			index,
			bit_value
	)

Get the pos in user units for a given user value in bits.

initialise()

def piezo.piezo.DevsimPiezo.initialise

(

self

)

Initialise various parameters of the simulated device.

reset_piezo_values()

def piezo.piezo.DevsimPiezo.reset_piezo_values

(

self

)

Reset piezo values.

RPC_Auto()

def piezo.piezo.DevsimPiezo.RPC_Auto	(		self,
			parent
	)

Execute SM Auto operation.

RPC_Disable()

def piezo.piezo.DevsimPiezo.RPC_Disable	(		self,
			parent
	)

Execute SM Disable operation.

RPC_Enable()

def piezo.piezo.DevsimPiezo.RPC_Enable	(		self,
			parent
	)

Execute SM Enable operation.

RPC_Home()

def piezo.piezo.DevsimPiezo.RPC_Home	(		self,
			parent
	)

Execute SM Auto operation.

RPC_Init()

def piezo.piezo.DevsimPiezo.RPC_Init	(		self,
			parent
	)

Initiate the initialisation procedure.

RPC_MoveBit()

def piezo.piezo.DevsimPiezo.RPC_MoveBit	(		self,
			parent,
			in_nPos1,
			in_nPos2,
			in_nPos3
	)

Execute MoveBits operation.

RPC_MoveUser()

def piezo.piezo.DevsimPiezo.RPC_MoveUser	(		self,
			parent,
			in_lrPos1,
			in_lrPos2,
			in_lrPos3
	)

Execute MoveUser operation.

RPC_Pos()

def piezo.piezo.DevsimPiezo.RPC_Pos	(		self,
			parent
	)

Execute SM Pos operation.

RPC_Reset()

def piezo.piezo.DevsimPiezo.RPC_Reset	(		self,
			parent
	)

Reset the Piezo Device (bring it to NotOp/NotReady).

RPC_Stop()

def piezo.piezo.DevsimPiezo.RPC_Stop	(		self,
			parent
	)

Execute SM Disable operation.

set_error_attribs()

def piezo.piezo.DevsimPiezo.set_error_attribs	(		self,
			error_code
	)

Set the "stat.nErrorCode"/"stat.sErrorText" node values.

set_rpc_error_attribs()

def piezo.piezo.DevsimPiezo.set_rpc_error_attribs	(		self,
			rpc_error_code
	)

Set the "stat.nRpcErrorCode"/"stat.sRpcErrorText" node values.

sim_thr_user()

def piezo.piezo.DevsimPiezo.sim_thr_user

(

self

)

Simulation Thread managing the piezo status.

Member Data Documentation

CFG_TODO

string piezo.piezo.DevsimPiezo.CFG_TODO = "TODO"

static

OPC UA Namespace Node IDs:

---

Configuration Node IDs:

CTRL_TODO

string piezo.piezo.DevsimPiezo.CTRL_TODO = "TODO"

static

initialised

piezo.piezo.DevsimPiezo.initialised

sim_init_time

piezo.piezo.DevsimPiezo.sim_init_time

STAT_COUNTER

string piezo.piezo.DevsimPiezo.STAT_COUNTER = "stat.nCycleCounter"

static

---

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

• devsim/piezo/src/ifw/fcf/devsim/piezo/piezo.py