EI_API_CIP_addClassService()

uint32_t EI_API_CIP_addClassService	(	T *	pCipNode_p,
		uint16_t	classId_p,
		EI_API_CIP_SService_t *	pService_p
	)

Add service/s to the class.

This Function that adds one or more service/s to the class specified by class identifier classId.

Parameters

[in]	pCipNode_p	Pointer to the CIP node.
[in]	classId_p	Class identifier.
[in]	pService_p	Service or services the class will support.

Returns

EI_API_CIP_EError_t as uint32_t value.

Return values

EI_API_CIP_eERR_OK	Success.
EI_API_CIP_eERR_NODE_INVALID	CIP node is invalid, possibly EI_API_CIP_NODE_new() was not called.
EI_API_CIP_eERR_CLASS_BLACKLIST	Operation on the CIP object with specified identifier (class ID) is not allowed.
EI_API_CIP_eERR_CLASS_DOES_NOT_EXIST	Class does not exists in CIP node dictionary.
EI_API_CIP_eERR_SERVICE_ALREADY_EXIST	Service already exists.
EI_API_CIP_eERR_SERVICE_PARAMETER	Wrong or invalid service parameters.
EI_API_CIP_eERR_SERVICE_INVALID	Service is invalid, possibly NULL pointer.
EI_API_CIP_eERR_MEMALLOC	Memory allocation error.
EI_API_CIP_eERR_NOT_IMPLEMENTED	Function not implemented.
EI_API_CIP_eERR_CLASS_UNKNOWN_STATE	Unknown state during class operation reached.

Example

#include <api/EI_API.h>
 
 
EI_API_ADP_T* pEI_API_ADP = NULL;
EI_API_CIP_NODE_T* pEI_API_CIP_NODE = NULL;
uint32_t errCode;
 
uint8_t numInterfaces = 1;
 
// Create a new adapter first
pEI_API_ADP = EI_API_ADP_new(numInterfaces);
 
// Create a CIP node next
pEI_API_CIP_NODE = EI_API_CIP_NODE_new();
 
// Create a class, here with class ID in vendor specific range
errCode = EI_API_CIP_createClass(pEI_API_CIP_NODE, 0x0064);
 
// Finally add a service to the class with ID 0x64
// Example for Get_Attribute_Single
EI_API_CIP_SService_t srvc;
srvc.code = EI_API_CIP_eSC_GETATTRSINGLE;
 
errCode = EI_API_CIP_addClassService(pEI_API_CIP_NODE, 0x0064, &srvc);

See also

EI_API_CIP_NODE_new EI_API_CIP_createClass EI_API_CIP_SService_t EI_API_CIP_EError_t