devsimShutter.DeviceSimulatorShutter Class Reference

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

Inheritance diagram for devsimShutter.DeviceSimulatorShutter:

Public Member Functions
def	__init__
	Initialize the Shutter Device simulator class; set the members. More...
def	data_change_handler
	Invoked when subscribed nodes changes value. More...
def	RPC_Close
def	RPC_Disable
def	RPC_Enable
def	RPC_Off
def	RPC_Init
def	RPC_Open
def	RPC_Reset
def	RPC_Stop
def	RPC_State
def	RPC_Test
def	RPC_GetNamespace
def	RPC_ReadNode
def	RPC_WriteNode
Public Member Functions inherited from deviceSimulatorBase.DeviceSimulatorBase
def	__init__
	Constructor, initializing the internal structures. More...
def	srv
	Return reference to Device Simulator server instance. More...
def	log
	Return reference to logger. More...
def	setDeviceInfo
	Set the internal (firmware) information about the simulated device. More...
def	init_device_parameters_
	Initialize various parameters of the simulated device. More...
def	write_node
	Write a node in the internal OPC UA namespace. More...
def	set_last_command
	Set the value of the simulated 'last command' node. More...
def	state_machine
	Return reference to the internal state machine (engine). More...
def	state_reg
	Return reference to the registry with mappings between state textual and numerical repr. More...
def	set_opcua_state
	Set the state/substate of the simulated device in the OPC UA namespace. More...
def	cfg
	Return reference to configuration object (NameMapping object). More...
def	get_opcua_state
	Return the OPC UA state as tuple (<numerical val>="">,<string val>="">). More...
def	opcua_server
	Return reference to the OPC UA server. More...
def	getnodes
	Return the OPC UA nodes as a list. More...
def	get_node_dic
	Return dictionary containing OPC UA nodes. More...
def	get_node
	Return object for node with given ID. More...
def	convert_node_value
	Convert an OPC UA node object value to a primitive value. More...
def	schedule_event
	Schedule an event. More...
def	get_node_value
	Get value of the node with the given ID. More...
def	implement_rpc_call_
	Issue warning to implement code for RPC call. More...
def	device_name
	Derive device name from the OPC UA profile (XML). More...
def	gen_node_id_
	Returns tupple (<symbolic node="" id>="">, <numeric node="" id>="">|0). More...
def	get_node_info_
	Extract the information about the given node, and possible sub-nodes. More...
def	set_node_permissions_
	Go throgh set of nodes and set the read/write permissions: More...
def	install_data_ch_subscr_
	Set up data subscriptions for cfg. More...
def	install_rpc_methods_
	Install callbacks for the defined RPC calls. More...
def	data_change_handler
	Invoked when nodes to which there is subscribed, change value. More...
def	get_node_prefix
	Extract the node prefix. More...
def	gen_opcua_state_node_ids_
def	execute
	Prepare for execution and execute the server. More...
def	__init__
	Constructor, initializing the internal structures. More...
def	srv
	Return reference to Device Simulator server instance. More...
def	log
	Return reference to logger. More...
def	setDeviceInfo
	Set the internal (firmware) information about the simulated device. More...
def	init_device_parameters_
	Initialize various parameters of the simulated device. More...
def	write_node
	Write a node in the internal OPC UA namespace. More...
def	set_last_command
	Set the value of the simulated 'last command' node. More...
def	state_machine
	Return reference to the internal state machine (engine). More...
def	state_reg
	Return reference to the registry with mappings between state textual and numerical repr. More...
def	set_opcua_state
	Set the state/substate of the simulated device in the OPC UA namespace. More...
def	cfg
	Return reference to configuration object (NameMapping object). More...
def	get_opcua_state
	Return the OPC UA state as tuple (<numerical val>="">,<string val>="">). More...
def	opcua_server
	Return reference to the OPC UA server. More...
def	getnodes
	Return the OPC UA nodes as a list. More...
def	get_node_dic
	Return dictionary containing OPC UA nodes. More...
def	get_node
	Return object for node with given ID. More...
def	convert_node_value
	Convert an OPC UA node object value to a primitive value. More...
def	schedule_event
	Schedule an event. More...
def	get_node_value
	Get value of the node with the given ID. More...
def	implement_rpc_call_
	Issue warning to implement code for RPC call. More...
def	device_name
	Derive device name from the OPC UA profile (XML). More...
def	gen_node_id_
	Returns tupple (<symbolic node="" id>="">, <numeric node="" id>="">|0). More...
def	get_node_info_
	Extract the information about the given node, and possible sub-nodes. More...
def	set_node_permissions_
	Go throgh set of nodes and set the read/write permissions: More...
def	install_data_ch_subscr_
	Set up data subscriptions for cfg. More...
def	install_rpc_methods_
	Install callbacks for the defined RPC calls. More...
def	data_change_handler
	Invoked when nodes to which there is subscribed, change value. More...
def	get_node_prefix
	Extract the node prefix. More...
def	gen_opcua_state_node_ids_
def	execute
	Prepare for execution and execute the server. More...

Static Public Attributes
int	RPC_RET_SHUTTER_STILL_OPENING = -4
	Shutter RPC return codes: More...
int	RPC_RET_SHUTTER_STILL_CLOSING = -5
int	RPC_RET_SHUTTER_SHUTTER_LOCAL = -6
Static Public Attributes inherited from deviceSimulatorBase.DeviceSimulatorBase
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"
int	RPC_RET_OK = 0
	Common RPC return codes: More...
int	RPC_RET_NOT_OP = -1
int	RPC_RET_NOT_NOTOP_READY = -2
int	RPC_RET_NOT_NOTOP_NOTREADY = -3

Detailed Description

Device Simulator class for the Standard Shutter Device.

Constructor & Destructor Documentation

def devsimShutter.DeviceSimulatorShutter.__init__

(

self

)

Initialize the Shutter Device simulator class; set the members.

Member Function Documentation

def devsimShutter.DeviceSimulatorShutter.data_change_handler	(		self,
			node,
			value,
			data
	)

Invoked when subscribed nodes changes value.

def devsimShutter.DeviceSimulatorShutter.RPC_Close	(		self,
			parent
	)

def devsimShutter.DeviceSimulatorShutter.RPC_Disable	(		self,
			parent
	)

def devsimShutter.DeviceSimulatorShutter.RPC_Enable	(		self,
			parent
	)

def devsimShutter.DeviceSimulatorShutter.RPC_GetNamespace	(		self,
			parent
	)

def devsimShutter.DeviceSimulatorShutter.RPC_Init	(		self,
			parent
	)

def devsimShutter.DeviceSimulatorShutter.RPC_Off	(		self,
			parent
	)

def devsimShutter.DeviceSimulatorShutter.RPC_Open	(		self,
			parent
	)

def devsimShutter.DeviceSimulatorShutter.RPC_ReadNode	(		self,
			parent,
			nodeId
	)

def devsimShutter.DeviceSimulatorShutter.RPC_Reset	(		self,
			parent
	)

def devsimShutter.DeviceSimulatorShutter.RPC_State	(		self,
			parent
	)

def devsimShutter.DeviceSimulatorShutter.RPC_Stop	(		self,
			parent
	)

def devsimShutter.DeviceSimulatorShutter.RPC_Test	(		self,
			parent,
			arg1,
			arg2
	)

def devsimShutter.DeviceSimulatorShutter.RPC_WriteNode	(		self,
			parent,
			node_id,
			value
	)

Member Data Documentation

int devsimShutter.DeviceSimulatorShutter.RPC_RET_SHUTTER_SHUTTER_LOCAL = -6

static

int devsimShutter.DeviceSimulatorShutter.RPC_RET_SHUTTER_STILL_CLOSING = -5

static

int devsimShutter.DeviceSimulatorShutter.RPC_RET_SHUTTER_STILL_OPENING = -4

static

Shutter RPC return codes:

---

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

• fcf/devsim/devsimShutter/src/devsimShutter.py