Client side data access (read/write) service functions

Typedefs
typedef void(*	IedConnection_ReadObjectHandler) (uint32_t invokeId, void *parameter, IedClientError err, MmsValue *value)

Functions
LIB61850_API MmsValue *	IedConnection_readObject (IedConnection self, IedClientError *error, const char *dataAttributeReference, FunctionalConstraint fc)
	read a functional constrained data attribute (FCDA) or functional constrained data (FCD). More...
LIB61850_API uint32_t	IedConnection_readObjectAsync (IedConnection self, IedClientError *error, const char *objRef, FunctionalConstraint fc, IedConnection_ReadObjectHandler handler, void *parameter)
	read a functional constrained data attribute (FCDA) or functional constrained data (FCD) - async version More...
LIB61850_API void	IedConnection_writeObject (IedConnection self, IedClientError *error, const char *dataAttributeReference, FunctionalConstraint fc, MmsValue *value)
	write a functional constrained data attribute (FCDA) or functional constrained data (FCD). More...
LIB61850_API uint32_t	IedConnection_writeObjectAsync (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, MmsValue *value, IedConnection_GenericServiceHandler handler, void *parameter)
	write a functional constrained data attribute (FCDA) or functional constrained data (FCD) - async version More...
LIB61850_API bool	IedConnection_readBooleanValue (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc)
	read a functional constrained data attribute (FCDA) of type boolean More...
LIB61850_API float	IedConnection_readFloatValue (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc)
	read a functional constrained data attribute (FCDA) of type float More...
LIB61850_API char *	IedConnection_readStringValue (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc)
	read a functional constrained data attribute (FCDA) of type VisibleString or MmsString More...
LIB61850_API int32_t	IedConnection_readInt32Value (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc)
	read a functional constrained data attribute (FCDA) of type Integer or Unsigned and return the result as int32_t More...
LIB61850_API int64_t	IedConnection_readInt64Value (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc)
	read a functional constrained data attribute (FCDA) of type Integer or Unsigned and return the result as int64_t More...
LIB61850_API uint32_t	IedConnection_readUnsigned32Value (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc)
	read a functional constrained data attribute (FCDA) of type Integer or Unsigned and return the result as uint32_t More...
LIB61850_API Timestamp *	IedConnection_readTimestampValue (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, Timestamp *timeStamp)
	read a functional constrained data attribute (FCDA) of type Timestamp (UTC Time) More...
LIB61850_API Quality	IedConnection_readQualityValue (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc)
	read a functional constrained data attribute (FCDA) of type Quality More...
LIB61850_API void	IedConnection_writeBooleanValue (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, bool value)
	write a functional constrained data attribute (FCDA) of type boolean More...
LIB61850_API void	IedConnection_writeInt32Value (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, int32_t value)
	write a functional constrained data attribute (FCDA) of type integer More...
LIB61850_API void	IedConnection_writeUnsigned32Value (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, uint32_t value)
	write a functional constrained data attribute (FCDA) of type unsigned (integer) More...
LIB61850_API void	IedConnection_writeFloatValue (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, float value)
	write a functional constrained data attribute (FCDA) of type float More...
LIB61850_API void	IedConnection_writeVisibleStringValue (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, char *value)
LIB61850_API void	IedConnection_writeOctetString (IedConnection self, IedClientError *error, const char *objectReference, FunctionalConstraint fc, uint8_t *value, int valueLength)

Detailed Description

Typedef Documentation

IedConnection_ReadObjectHandler

typedef void(* IedConnection_ReadObjectHandler) (uint32_t invokeId, void *parameter, IedClientError err, MmsValue *value)

Function Documentation

IedConnection_readBooleanValue()

LIB61850_API bool IedConnection_readBooleanValue	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc
	)

read a functional constrained data attribute (FCDA) of type boolean

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the data attribute to read
fc	the functional constraint of the data attribute to read

IedConnection_readFloatValue()

LIB61850_API float IedConnection_readFloatValue	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc
	)

read a functional constrained data attribute (FCDA) of type float

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the data attribute to read
fc	the functional constraint of the data attribute to read

IedConnection_readInt32Value()

LIB61850_API int32_t IedConnection_readInt32Value	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc
	)

read a functional constrained data attribute (FCDA) of type Integer or Unsigned and return the result as int32_t

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the data attribute to read
fc	the functional constraint of the data attribute to read

Returns

an int32_t value of the read data attributes

IedConnection_readInt64Value()

LIB61850_API int64_t IedConnection_readInt64Value	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc
	)

read a functional constrained data attribute (FCDA) of type Integer or Unsigned and return the result as int64_t

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the data attribute to read
fc	the functional constraint of the data attribute to read

Returns

an int64_t value of the read data attributes

IedConnection_readObject()

LIB61850_API MmsValue* IedConnection_readObject	(	IedConnection	self,
		IedClientError *	error,
		const char *	dataAttributeReference,
		FunctionalConstraint	fc
	)

read a functional constrained data attribute (FCDA) or functional constrained data (FCD).

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the object/attribute to read
fc	the functional constraint of the data attribute or data object to read

Returns

the MmsValue instance of the received value or NULL if the request failed

IedConnection_readObjectAsync()

LIB61850_API uint32_t IedConnection_readObjectAsync	(	IedConnection	self,
		IedClientError *	error,
		const char *	objRef,
		FunctionalConstraint	fc,
		IedConnection_ReadObjectHandler	handler,
		void *	parameter
	)

read a functional constrained data attribute (FCDA) or functional constrained data (FCD) - async version

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the object/attribute to read
fc	the functional constraint of the data attribute or data object to read
handler	the user provided callback handler
parameter	user provided parameter that is passed to the callback handler

Returns

the invoke ID of the request

IedConnection_readQualityValue()

LIB61850_API Quality IedConnection_readQualityValue	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc
	)

read a functional constrained data attribute (FCDA) of type Quality

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the data attribute to read
fc	the functional constraint of the data attribute to read

Returns

the timestamp value

IedConnection_readStringValue()

LIB61850_API char* IedConnection_readStringValue	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc
	)

read a functional constrained data attribute (FCDA) of type VisibleString or MmsString

NOTE: the returned char buffer is dynamically allocated and has to be freed by the caller!

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the data attribute to read
fc	the functional constraint of the data attribute to read

Returns

a C string representation of the value. Has to be freed by the caller!

IedConnection_readTimestampValue()

LIB61850_API Timestamp* IedConnection_readTimestampValue	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc,
		Timestamp *	timeStamp
	)

read a functional constrained data attribute (FCDA) of type Timestamp (UTC Time)

NOTE: If the timestamp parameter is set to NULL the function allocates a new timestamp instance. Otherwise the return value is a pointer to the user provided timestamp instance. The new timestamp instance has to be freed by the caller of the function.

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the data attribute to read
fc	the functional constraint of the data attribute to read
timestamp	a pointer to a user provided timestamp instance or NULL

Returns

the timestamp value

IedConnection_readUnsigned32Value()

LIB61850_API uint32_t IedConnection_readUnsigned32Value	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc
	)

read a functional constrained data attribute (FCDA) of type Integer or Unsigned and return the result as uint32_t

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the data attribute to read
fc	the functional constraint of the data attribute to read

Returns

an uint32_t value of the read data attributes

IedConnection_writeBooleanValue()

LIB61850_API void IedConnection_writeBooleanValue	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc,
		bool	value
	)

write a functional constrained data attribute (FCDA) of type boolean

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the data attribute to read
fc	the functional constraint of the data attribute or data object to write
value	the boolean value to write

IedConnection_writeFloatValue()

LIB61850_API void IedConnection_writeFloatValue	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc,
		float	value
	)

write a functional constrained data attribute (FCDA) of type float

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the data attribute to read
fc	the functional constraint of the data attribute or data object to write
value	the float value to write

IedConnection_writeInt32Value()

LIB61850_API void IedConnection_writeInt32Value	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc,
		int32_t	value
	)

write a functional constrained data attribute (FCDA) of type integer

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the data attribute to read
fc	the functional constraint of the data attribute or data object to write
value	the int32_t value to write

IedConnection_writeObject()

LIB61850_API void IedConnection_writeObject	(	IedConnection	self,
		IedClientError *	error,
		const char *	dataAttributeReference,
		FunctionalConstraint	fc,
		MmsValue *	value
	)

write a functional constrained data attribute (FCDA) or functional constrained data (FCD).

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the object/attribute to write
fc	the functional constraint of the data attribute or data object to write
value	the MmsValue to write (has to be of the correct type - MMS_STRUCTURE for FCD)

IedConnection_writeObjectAsync()

LIB61850_API uint32_t IedConnection_writeObjectAsync	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc,
		MmsValue *	value,
		IedConnection_GenericServiceHandler	handler,
		void *	parameter
	)

write a functional constrained data attribute (FCDA) or functional constrained data (FCD) - async version

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the object/attribute to write
fc	the functional constraint of the data attribute or data object to write
value	the MmsValue to write (has to be of the correct type - MMS_STRUCTURE for FCD)
handler	the user provided callback handler
parameter	user provided parameter that is passed to the callback handler

Returns

the invoke ID of the request

IedConnection_writeOctetString()

LIB61850_API void IedConnection_writeOctetString	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc,
		uint8_t *	value,
		int	valueLength
	)

IedConnection_writeUnsigned32Value()

LIB61850_API void IedConnection_writeUnsigned32Value	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc,
		uint32_t	value
	)

write a functional constrained data attribute (FCDA) of type unsigned (integer)

Parameters

self	the connection object to operate on
error	the error code if an error occurs
object	reference of the data attribute to read
fc	the functional constraint of the data attribute or data object to write
value	the uint32_t value to write

IedConnection_writeVisibleStringValue()

LIB61850_API void IedConnection_writeVisibleStringValue	(	IedConnection	self,
		IedClientError *	error,
		const char *	objectReference,
		FunctionalConstraint	fc,
		char *	value
	)