The pdo operation manager class is to send pdo. More...

#include <IOManagerPDO.h>

Inherits IOManager.

Public Member Functions
	IOManagerPDO ()
	construction More...

virtual	~IOManagerPDO ()
	destruction More...

UaStatus	beginTransaction (IOManagerCallback *pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 hTransaction, OpcUa_UInt32 totalItemCountHint, OpcUa_Double maxAge, OpcUa_TimestampsToReturn timestampsToReturn, TransactionType transactionType, OpcUa_Handle &hIOManagerContext)
	Start a transaction. More...

UaStatus	beginStartMonitoring (OpcUa_Handle hIOManagerContext, OpcUa_UInt32 callbackHandle, IOVariableCallback pIOVariableCallback, VariableHandle pVariableHandle, MonitoringContext &monitoringContext)
	dummy function. monitoring operations execute by standard IO manager More...

UaStatus	beginModifyMonitoring (OpcUa_Handle hIOManagerContext, OpcUa_UInt32 callbackHandle, OpcUa_UInt32 hIOVariable, MonitoringContext &monitoringContext)
	dummy function. monitoring operations execute by standard IO manager More...

UaStatus	beginStopMonitoring (OpcUa_Handle hIOManagerContext, OpcUa_UInt32 callbackHandle, OpcUa_UInt32 hIOVariable)
	Notify IOManager after stopping monitoring of an item. More...

UaStatus	beginRead (OpcUa_Handle hIOManagerContext, OpcUa_UInt32 callbackHandle, VariableHandle pVariableHandle, OpcUa_ReadValueId pReadValueId)
	dummy function. read operation executes by standard IO manager More...

UaStatus	beginWrite (OpcUa_Handle hIOManagerContext, OpcUa_UInt32 callbackHandle, VariableHandle pVariableHandle, OpcUa_WriteValue pWriteValue)
	Write attribute value of a node. More...

UaStatus	finishTransaction (OpcUa_Handle hIOManagerContext)
	Finish a transaction. More...

Private Member Functions
	UA_DISABLE_COPY (IOManagerPDO)

Detailed Description

The pdo operation manager class is to send pdo.

This class ensure mapping data from PDO items, save and send PDO message on the bus.
All input/output managers in Ua SDK toolkit have a standard interface which have execute reading , writing and monitoring data from device.
This manager have to ensure only write operation on the can bus.

Definition at line 16 of file IOManagerPDO.h.

Constructor & Destructor Documentation

◆ IOManagerPDO()

CanOpen::IOManagerPDO::IOManagerPDO ( )

construction

Definition at line 17 of file IOManagerPDO.cpp.

◆ ~IOManagerPDO()

CanOpen::IOManagerPDO::~IOManagerPDO ( )

virtual

destruction

Definition at line 23 of file IOManagerPDO.cpp.

Member Function Documentation

◆ beginModifyMonitoring()

UaStatus CanOpen::IOManagerPDO::beginModifyMonitoring	(	OpcUa_Handle	hIOManagerContext,
		OpcUa_UInt32	callbackHandle,
		OpcUa_UInt32	hIOVariable,
		MonitoringContext &	monitoringContext
	)

dummy function. monitoring operations execute by standard IO manager

Notify IOManager after modifying monitoring parameters of an item.

Parameters

hIOManagerContext	IOManager handle for the transaction context. This handle is used to identify the transaction in the IOManager.
callbackHandle	Handle for the node in the callback. This handle was passed in to the IOManager with the beginModifyMonitoring method.
hIOVariable	The handle of the variable in the IOManager created with beginStartMonitoring. The handle was passed to the SDK in the callback finishStartMonitoring.
monitoringContext	handle for the monitoring context.

Returns: Error code

Definition at line 269 of file IOManagerPDO.cpp.

◆ beginRead()

UaStatus CanOpen::IOManagerPDO::beginRead	(	OpcUa_Handle	hIOManagerContext,
		OpcUa_UInt32	callbackHandle,
		VariableHandle *	pVariableHandle,
		OpcUa_ReadValueId *	pReadValueId
	)

dummy function. read operation executes by standard IO manager

Read attribute value of a node.

This function does not do any thing for this manager

Parameters

hIOManagerContext	IOManager handle for the transaction context. This handle is used to identify the transaction in the IOManager.
callbackHandle	Handle for the node in the callback. This handle was passed in to the IOManager with the beginModifyMonitoring method.
pVariableHandle	Variable handle provided by the NodeManager::getVariableHandle. This object contains the information needed by the IOManager to identify the node to read in its context.
pReadValueId	Context for the node to read. The context contains the IndexRange and the DataEncoding requested by the client. The other parameters of this context are already handled by the VariableHandle.

Returns: Error code

Definition at line 162 of file IOManagerPDO.cpp.

◆ beginStartMonitoring()

UaStatus CanOpen::IOManagerPDO::beginStartMonitoring	(	OpcUa_Handle	hIOManagerContext,
		OpcUa_UInt32	callbackHandle,
		IOVariableCallback *	pIOVariableCallback,
		VariableHandle *	pVariableHandle,
		MonitoringContext &	monitoringContext
	)

dummy function. monitoring operations execute by standard IO manager

Start monitoring of an item.

This function does not do any thing for this manager

Parameters

hIOManagerContext	IOManager handle for the transaction context. This handle is used to identify the transaction in the IOManager.
callbackHandle	Handle for the node in the callback. This handle was passed in to the IOManager with the beginModifyMonitoring method.
pIOVariableCallback	Callback interface used for data change callbacks to the MonitoredItem managed by the SDK.
pVariableHandle	Variable handle provided by the NodeManager::getVariableHandle. This object contains the information needed by the IOManager to identify the node to read in its context.
monitoringContext	handle for the monitoring context.

Returns: Error code

Definition at line 245 of file IOManagerPDO.cpp.

◆ beginStopMonitoring()

UaStatus CanOpen::IOManagerPDO::beginStopMonitoring	(	OpcUa_Handle	hIOManagerContext,
		OpcUa_UInt32	callbackHandle,
		OpcUa_UInt32	hIOVariable
	)

Notify IOManager after stopping monitoring of an item.

This function does not do any thing for this manager

Parameters

hIOManagerContext	IOManager handle for the transaction context. This handle is used to identify the transaction in the IOManager.
callbackHandle	Handle for the node in the callback. This handle was passed in to the IOManager with the beginModifyMonitoring method.
hIOVariable	The handle of the variable in the IOManager created with beginStartMonitoring. The handle was passed to the SDK in the callback finishStartMonitoring.

Returns: Error code

Definition at line 291 of file IOManagerPDO.cpp.

◆ beginTransaction()

UaStatus CanOpen::IOManagerPDO::beginTransaction	(	IOManagerCallback *	pCallback,
		const ServiceContext &	serviceContext,
		OpcUa_UInt32	hTransaction,
		OpcUa_UInt32	totalItemCountHint,
		OpcUa_Double	maxAge,
		OpcUa_TimestampsToReturn	timestampsToReturn,
		TransactionType	transactionType,
		OpcUa_Handle &	hIOManagerContext
	)

Start a transaction.

Parameters

pCallback	Callback interface used for the transaction. The IOManager must use this interface to finish the action for each passed node in the transaction.
serviceContext	General context for the service calls containing information like the session object, return diagnostic mask and timeout hint.
hTransaction	Handle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the IOManager with the beginTransaction method.
totalItemCountHint	A hint for the IOManager about the total number of nodes in the transaction. The IOManager may not be responsible for all nodes but he can use this hint if he wants to optimize memory allocation.
maxAge	Max age parameter used only in the Read service.
timestampsToReturn	Indicates which timestamps should be returned in a Read or a Publish response. The possible enum values are: OpcUa_TimestampsToReturn_Source OpcUa_TimestampsToReturn_Server OpcUa_TimestampsToReturn_Both OpcUa_TimestampsToReturn_Neither
transactionType	Type of the transaction. The possible enum values are: READ WRITE MONITOR_BEGIN MONITOR_MODIFY MONITOR_STOP
hIOManagerContext	IOManager handle for the transaction context. This handle is used to identify the transaction in the IOManager.

Returns: Error code

Definition at line 49 of file IOManagerPDO.cpp.

◆ beginWrite()

UaStatus CanOpen::IOManagerPDO::beginWrite	(	OpcUa_Handle	hIOManagerContext,
		OpcUa_UInt32	callbackHandle,
		VariableHandle *	pVariableHandle,
		OpcUa_WriteValue *	pWriteValue
	)

Write attribute value of a node.

Parameters

hIOManagerContext	IOManager handle for the transaction context. This handle is used to identify the transaction in the IOManager.
callbackHandle	Handle for the node in the callback. This handle was passed in to the IOManager with the beginModifyMonitoring method.
pVariableHandle	Variable handle provided by the NodeManager::getVariableHandle. This object contains the information needed by the IOManager to identify the node to read in its context.
pWriteValue	Context for the node to write. The context contains the IndexRange requested by the client. The NodeId and Attribute parameters of this context are already handled by the VariableHandle

Returns: Error code

Definition at line 183 of file IOManagerPDO.cpp.

◆ finishTransaction()

UaStatus CanOpen::IOManagerPDO::finishTransaction ( OpcUa_Handle hIOManagerContext )

Finish a transaction.

Parameters

hIOManagerContext IOManager handle for the transaction context. This handle is used to identify the transaction in the IOManager.

Returns: Error code

Definition at line 108 of file IOManagerPDO.cpp.

◆ UA_DISABLE_COPY()

CanOpen::IOManagerPDO::UA_DISABLE_COPY ( IOManagerPDO )

private

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

CanOpen/include/IOManagerPDO.h
CanOpen/src/IOManagerPDO.cpp

Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ IOManagerPDO()

◆ ~IOManagerPDO()

Member Function Documentation

◆ beginModifyMonitoring()

◆ beginRead()

◆ beginStartMonitoring()

◆ beginStopMonitoring()

◆ beginTransaction()

◆ beginWrite()

◆ finishTransaction()

◆ UA_DISABLE_COPY()