Model discovery services

Enumerations
enum	ACSIClass {   ACSI_CLASS_DATA_OBJECT, ACSI_CLASS_DATA_SET, ACSI_CLASS_BRCB, ACSI_CLASS_URCB,   ACSI_CLASS_LCB, ACSI_CLASS_LOG, ACSI_CLASS_SGCB, ACSI_CLASS_GoCB,   ACSI_CLASS_GsCB, ACSI_CLASS_MSVCB, ACSI_CLASS_USVCB }

Functions
void	IedConnection_getDeviceModelFromServer (IedConnection self, IedClientError *error)
	Retrieve the device model from the server. More...
LinkedList	IedConnection_getLogicalDeviceList (IedConnection self, IedClientError *error)
	Get the list of logical devices available at the server (DEPRECATED) More...
LinkedList	IedConnection_getServerDirectory (IedConnection self, IedClientError *error, bool getFileNames)
	Get the list of logical devices or files available at the server. More...
LinkedList	IedConnection_getLogicalDeviceDirectory (IedConnection self, IedClientError *error, const char *logicalDeviceName)
	Get the list of logical nodes (LN) of a logical device. More...
LinkedList	IedConnection_getLogicalNodeVariables (IedConnection self, IedClientError *error, const char *logicalNodeReference)
	returns a list of all MMS variables that are children of the given logical node More...
LinkedList	IedConnection_getLogicalNodeDirectory (IedConnection self, IedClientError *error, const char *logicalNodeReference, ACSIClass acsiClass)
	returns the directory of the given logical node (LN) containing elements of the specified ACSI class More...
LinkedList	IedConnection_getDataDirectory (IedConnection self, IedClientError *error, const char *dataReference)
	returns the directory of the given data object (DO) More...
LinkedList	IedConnection_getDataDirectoryFC (IedConnection self, IedClientError *error, const char *dataReference)
	returns the directory of the given data object (DO) More...
LinkedList	IedConnection_getDataDirectoryByFC (IedConnection self, IedClientError *error, const char *dataReference, FunctionalConstraint fc)
	returns the directory of the given data object/data attribute with the given FC More...
MmsVariableSpecification *	IedConnection_getVariableSpecification (IedConnection self, IedClientError *error, const char *dataAttributeReference, FunctionalConstraint fc)
	return the MMS variable type specification of the data attribute referenced by dataAttributeReference and function constraint fc. More...

Detailed Description

Enumeration Type Documentation

enum ACSIClass

Enumerator
ACSI_CLASS_DATA_OBJECT
ACSI_CLASS_DATA_SET
ACSI_CLASS_BRCB
ACSI_CLASS_URCB
ACSI_CLASS_LCB
ACSI_CLASS_LOG
ACSI_CLASS_SGCB
ACSI_CLASS_GoCB
ACSI_CLASS_GsCB
ACSI_CLASS_MSVCB
ACSI_CLASS_USVCB

Function Documentation

LinkedList IedConnection_getDataDirectory	(	IedConnection	self,
		IedClientError *	error,
		const char *	dataReference
	)

returns the directory of the given data object (DO)

Implementation of the GetDataDirectory ACSI service. This will return the list of all data attributes or sub data objects.

Parameters

self	the connection object
error	the error code if an error occurs
dataReference	string that represents the DO reference

Returns

list of all data attributes or sub data objects as C strings in a LinkedList

LinkedList IedConnection_getDataDirectoryByFC	(	IedConnection	self,
		IedClientError *	error,
		const char *	dataReference,
		FunctionalConstraint	fc
	)

returns the directory of the given data object/data attribute with the given FC

Implementation of the GetDataDirectory ACSI service. This will return the list of C strings with all data attributes or sub data objects as elements.

WARNING: Starting with version 1.0.3 the functional constraint will no longer be appended to the name string.

Parameters

self	the connection object
error	the error code if an error occurs
dataReference	string that represents the DO reference
fc	the functional constraint

Returns

list of all data attributes or sub data objects as C strings in a LinkedList

LinkedList IedConnection_getDataDirectoryFC	(	IedConnection	self,
		IedClientError *	error,
		const char *	dataReference
	)

returns the directory of the given data object (DO)

Implementation of the GetDataDirectory ACSI service. This will return the list of C strings with all data attributes or sub data objects as elements. The returned strings will contain the functional constraint appended in square brackets when appropriate.

Parameters

self	the connection object
error	the error code if an error occurs
dataReference	string that represents the DO reference

Returns

list of all data attributes or sub data objects as C strings in a LinkedList

void IedConnection_getDeviceModelFromServer	(	IedConnection	self,
		IedClientError *	error
	)

Retrieve the device model from the server.

This function retrieves the complete device model from the server. The model is buffered an can be browsed by subsequent API calls. This API call is mapped to multiple ACSI services.

Parameters

self	the connection object
error	the error code if an error occurs

LinkedList IedConnection_getLogicalDeviceDirectory	(	IedConnection	self,
		IedClientError *	error,
		const char *	logicalDeviceName
	)

Get the list of logical nodes (LN) of a logical device.

GetLogicalDeviceDirectory ACSI service implementation. Returns the list of logical nodes names present in a logical device. The list is returned as a linked list of type LinkedList with c style string elements.

Parameters

self	the connection object
error	the error code if an error occurs
logicalDeviceName	the name of the logical device (LD) of interest

Returns

LinkedList with string elements representing the logical node names

LinkedList IedConnection_getLogicalDeviceList	(	IedConnection	self,
		IedClientError *	error
	)

Get the list of logical devices available at the server (DEPRECATED)

This function is mapped to the GetServerDirectory(LD) ACSI service.

Parameters

self	the connection object
error	the error code if an error occurs

Returns

LinkedList with string elements representing the logical device names

LinkedList IedConnection_getLogicalNodeDirectory	(	IedConnection	self,
		IedClientError *	error,
		const char *	logicalNodeReference,
		ACSIClass	acsiClass
	)

returns the directory of the given logical node (LN) containing elements of the specified ACSI class

Implementation of the GetLogicalNodeDirectory ACSI service. In contrast to the ACSI description this function does not always creates a request to the server. For most ACSI classes it simply accesses the data model that was retrieved before. An exception to this rule are the ACSI classes ACSI_CLASS_DATASET and ACSI_CLASS_LOG. Both always perform a request to the server.

Parameters

self	the connection object
error	the error code if an error occurs
logicalNodeReference	string that represents the LN reference
acsiClass	specifies the ACSI class

Returns

list of all logical node elements of the specified ACSI class type as C strings in a LinkedList

LinkedList IedConnection_getLogicalNodeVariables	(	IedConnection	self,
		IedClientError *	error,
		const char *	logicalNodeReference
	)

returns a list of all MMS variables that are children of the given logical node

This function cannot be mapped to any ACSI service. It is a convenience function for generic clients that wants to show a list of all available children of the MMS named variable representing the logical node.

Parameters

self	the connection object
error	the error code if an error occurs
logicalNodeReference	string that represents the LN reference

Returns

the list of all MMS named variables as C strings in a LinkedList type

LinkedList IedConnection_getServerDirectory	(	IedConnection	self,
		IedClientError *	error,
		bool	getFileNames
	)

Get the list of logical devices or files available at the server.

GetServerDirectory ACSI service implementation. This function will either return the list of logical devices (LD) present at the server or the list of available files.

Parameters

self	the connection object
error	the error code if an error occurs
getFileNames	get list of files instead of logical device names (TO BE IMPLEMENTED)

Returns

LinkedList with string elements representing the logical device names or file names

MmsVariableSpecification* IedConnection_getVariableSpecification	(	IedConnection	self,
		IedClientError *	error,
		const char *	dataAttributeReference,
		FunctionalConstraint	fc
	)

return the MMS variable type specification of the data attribute referenced by dataAttributeReference and function constraint fc.

This function can be used to get the MMS variable type specification for an IEC 61850 data attribute. It is an extension of the ACSI that may be required by generic client applications.

NOTE: API user is responsible to free the resources (see MmsVariableSpecification_destroy)

Parameters

self	the connection object
error	the error code if an error occurs
dataAttributeReference	string that represents the DA reference
fc	functional constraint of the DA

Returns

MmsVariableSpecification of the data attribute.