EI_API_CIP_cloneInstance()

uint32_t EI_API_CIP_cloneInstance	(	T *	pCipNode_p,
		uint16_t	classId_p,
		uint16_t	instanceId_p,
		uint16_t	instanceIdSrc_p
	)

Clone attributes from source instance to a another/new instance.

This function can be used to clone the attributes of an instance to another one. The cloning helps during initialization if there are multiple instances with the same attributes.

Remarks

This function creates the new instance with the identifier passed as parameter instanceId_p.

Parameters

[in]	pCipNode_p	Pointer to the CIP node.
[in]	classId_p	Class identifier.
[in]	instanceId_p	Instance identifier.
[in]	instanceIdSrc_p	Instance identifier of the source instance.

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) are not allowed.
EI_API_CIP_eERR_CLASS_ALREADY_EXIST	Class already exists in CIP node dictionary.
EI_API_CIP_eERR_CLASS_DOES_NOT_EXIST	Class does not exists in CIP node dictionary.
EI_API_CIP_eERR_CLASS_UNKNOWN_STATE	Unknown state during class operation reached.
EI_API_CIP_eERR_INSTANCE_ALREADY_EXIST	Instance already exists in CIP node dictionary.
EI_API_CIP_eERR_INSTANCE_DOES_NOT_EXIST	Instance does not exist in CIP node dictionary.
EI_API_CIP_eERR_INSTANCE_UNKNOWN_STATE	Unknown state during class operation reached.
EI_API_CIP_eERR_ATTRIBUTE_ALREADY_EXIST	Attribute already exists in class or instance.
EI_API_CIP_eERR_ATTRIBUTE_DOES_NOT_EXIST	Attribute does not exist in class or instance.
EI_API_CIP_eERR_ATTRIBUTE_NOT_IMPLEMENTED	Attribute function not implemented.
EI_API_CIP_eERR_ATTRIBUTE_INVALID_VALUE	Invalid data pointer.
EI_API_CIP_eERR_ATTRIBUTE_CDT_SIZE	Passed constructed data type size for e.g. farray not within valid range.
EI_API_CIP_eERR_ATTRIBUTE_EDT_SIZE	Passed elementary data type size for e.g. short string not within valid range.
EI_API_CIP_eERR_ATTRIBUTE_UNKNOWN_STATE	Unknown state during attribute operation reached.
EI_API_CIP_eERR_SERVICE_ALREADY_EXIST	Service already exist.
EI_API_CIP_eERR_SERVICE_PARAMETER	Wrong or invalid service parameters.
EI_API_CIP_eERR_DICTIONARY_FULL	CIP dictionary is full, no more class or instance can be added.
EI_API_CIP_eERR_NOT_IMPLEMENTED	Not implemented function.
EI_API_CIP_eERR_MEMALLOC	Memory allocation error.

Example

#include <api/EI_API.h>
 
 
EI_API_ADP_T* pEI_API_ADP = NULL;
EI_API_CIP_NODE_T* pEI_API_CIP_NODE = NULL;
EI_API_CIP_SAttr_t attr;
uint32_t errCode;
 
uint8_t numInterfaces = 1;
uint16_t classId = 0x0064;
uint16_t instanceId = 0x01;
 
// 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
errCode = EI_API_CIP_createClass(pEI_API_CIP_NODE, classId);
 
// Create instance in class with identifier classId
errCode = EI_API_CIP_createInstance(pEI_API_CIP_NODE, classId, instanceId);
 
// Attribute parameter set
attr.id = 0x01;
attr.accessRule = EI_API_CIP_eAR_GET;
attr.edt = EI_API_CIP_eEDT_UINT;
attr.cdt = EI_API_CIP_eCDT_NO;
attr.edtSize = 0;
attr.cdtSize = 0;
 
errCode = EI_API_CIP_addInstanceAttr(pEI_API_CIP_NODE, classId, instanceId, &attr);
 
attr.id = 0x02;
attr.accessRule = EI_API_CIP_eAR_GET;
attr.edt = EI_API_CIP_eEDT_UINT;
attr.cdt = EI_API_CIP_eCDT_NO;
attr.edtSize = 0;
attr.cdtSize = 0;
 
errCode = EI_API_CIP_addInstanceAttr(pEI_API_CIP_NODE, classId, instanceId, &attr);
 
// Create two instances (0x0002 and 0x0003) with the same attributes as instanceId 0x0001 (source instance ID)
errCode = EI_API_CIP_cloneInstance(pEI_API_CIP_NODE, classId, 0x0002, instanceId);
errCode = EI_API_CIP_cloneInstance(pEI_API_CIP_NODE, classId, 0x0003, instanceId);

See also

EI_API_CIP_createClass EI_API_CIP_createInstance EI_API_CIP_addInstanceAttr EI_API_CIP_SAttr_t EI_API_CIP_EError_t