fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase Class Reference

Device Simulator base class. More...

Inheritance diagram for fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase:

Public Member Functions
def	__init__
	Constructor, initialising the internal structures. More...
def	set_sim_thr_period
	Set the period for executing the Simulation Thread (in seconds). More...
def	get_sim_thr_period
	Get the period for executing the Simulation Thread (in seconds). More...
def	execute_sim_thr
	Invoke to run the Simulation Thread. More...
def	set_sim_thr_exec_time
	Set the time when the Simulation Thread executed. More...
def	get_sim_thr_exec_time
	Return the timestamp for the last execution (in seconds since epoch). More...
def	stop_sim_thr
	Signal to the Simulation Thread to stop execution. More...
def	stop_srv_threads_user
	Stop the application specific internal server threads. More...
def	set_device_info
	Set the internal (firmware) information about the simulated device. More...
def	get_update_frequency
def	initialise
	Initialise various parameters of the simulated device. More...
def	sim_thr
	Simulation Thread used to implement simulation logic to run in background. More...
def	sim_thr_user
	Simulation Thread, which shall contain the business logic for the device simulated. More...
def	data_change_handler
	Invoked when subscribed nodes changes value. More...
def	local_mode
	Return value of Local Mode flag. More...
def	RPC_Enable
	Execute SM Enable operation. More...
def	RPC_Disable
	Execute SM Disable operation. More...
def	RPC_Off
	Power off Device Simulator. More...
def	RPC_Init
	Start initialisation operation. More...
def	RPC_Reset
	Execute SM Reset operation. More...
def	RPC_SetDebug
	Change debug level. More...
def	RPC_SetLog
	Set log level. More...
def	RPC_Stop
	Stop an ob-going operation. More...
def	RPC_State
	Request state of Device Simulator. More...
def	RPC_GetNamespace
	Get OPC UA namespace currently installed in Device Simulator. More...
def	RPC_ReadNode
	Read a node from the Device Simulator namespace. More...
def	RPC_WriteNode
	Write a node in the Device Simulator namespace. More...

Public Attributes
	cycle_counter

Static Public Attributes
string	NODE_INFO_DESCRIPTION = "sDescription"
string	NODE_INFO_NAME = "sName"
string	NODE_INFO_PLATFORM = "sPlatform"
string	NODE_INFO_SYNOPSIS = "sSynopsis"
string	NODE_INFO_VERDATE = "sDate"
string	NODE_INFO_VERSION_MAJOR = "nVersionMajor"
string	NODE_INFO_VERSION_MINOR = "nVersionMinor"
string	STAT_COUNTER = "stat.nCounter"

Detailed Description

Device Simulator base class.

All Device Simulators shall be derived from this.

Constructor & Destructor Documentation

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.__init__	(		self,
			context = None,
			location_state_attributes = "stat"
	)

Constructor, initialising the internal structures.

Member Function Documentation

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.data_change_handler	(		self,
			node,
			value,
			data
	)

Invoked when subscribed nodes changes value.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.execute_sim_thr

(

self

)

Invoke to run the Simulation Thread.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.get_sim_thr_exec_time

(

self

)

Return the timestamp for the last execution (in seconds since epoch).

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.get_sim_thr_period

(

self

)

Get the period for executing the Simulation Thread (in seconds).

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.get_update_frequency

(

self

)

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.initialise

(

self

)

Initialise various parameters of the simulated device.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.local_mode

(

self

)

Return value of Local Mode flag.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.RPC_Disable	(		self,
			parent
	)

Execute SM Disable operation.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.RPC_Enable	(		self,
			parent
	)

Execute SM Enable operation.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.RPC_GetNamespace	(		self,
			parent
	)

Get OPC UA namespace currently installed in Device Simulator.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.RPC_Init	(		self,
			parent
	)

Start initialisation operation.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.RPC_Off	(		self,
			parent
	)

Power off Device Simulator.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.RPC_ReadNode	(		self,
			parent,
			node_id
	)

Read a node from the Device Simulator namespace.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.RPC_Reset	(		self,
			parent
	)

Execute SM Reset operation.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.RPC_SetDebug	(		self,
			parent
	)

Change debug level.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.RPC_SetLog	(		self,
			parent
	)

Set log level.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.RPC_State	(		self,
			parent
	)

Request state of Device Simulator.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.RPC_Stop	(		self,
			parent
	)

Stop an ob-going operation.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.RPC_WriteNode	(		self,
			parent,
			node_id,
			value
	)

Write a node in the Device Simulator namespace.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.set_device_info	(		self,
			description,
			name,
			platform,
			synopsis,
			version_date,
			version_major,
			version_minor
	)

Set the internal (firmware) information about the simulated device.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.set_sim_thr_exec_time	(		self,
			exec_time
	)

Set the time when the Simulation Thread executed.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.set_sim_thr_period	(		self,
			period_secs
	)

Set the period for executing the Simulation Thread (in seconds).

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.sim_thr

(

self

)

Simulation Thread used to implement simulation logic to run in background.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.sim_thr_user

(

self

)

Simulation Thread, which shall contain the business logic for the device simulated.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.stop_sim_thr

(

self

)

Signal to the Simulation Thread to stop execution.

def fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.stop_srv_threads_user

(

self

)

Stop the application specific internal server threads.

Member Data Documentation

fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.cycle_counter

string fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.NODE_INFO_DESCRIPTION = "sDescription"

static

string fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.NODE_INFO_NAME = "sName"

static

string fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.NODE_INFO_PLATFORM = "sPlatform"

static

string fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.NODE_INFO_SYNOPSIS = "sSynopsis"

static

string fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.NODE_INFO_VERDATE = "sDate"

static

string fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.NODE_INFO_VERSION_MAJOR = "nVersionMajor"

static

string fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.NODE_INFO_VERSION_MINOR = "nVersionMinor"

static

string fcfDevsimLib.deviceSimulatorBase.DeviceSimulatorBase.STAT_COUNTER = "stat.nCounter"

static

---

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

• devsim/lib/src/fcfDevsimLib/deviceSimulatorBase.py