Typedefs
typedef struct sMmsValue	MmsValue

Enumerations
enum	MmsDataAccessError { DATA_ACCESS_ERROR_NO_RESPONSE = -2, DATA_ACCESS_ERROR_SUCCESS = -1, DATA_ACCESS_ERROR_OBJECT_INVALIDATED = 0, DATA_ACCESS_ERROR_HARDWARE_FAULT = 1, DATA_ACCESS_ERROR_TEMPORARILY_UNAVAILABLE = 2, DATA_ACCESS_ERROR_OBJECT_ACCESS_DENIED = 3, DATA_ACCESS_ERROR_OBJECT_UNDEFINED = 4, DATA_ACCESS_ERROR_INVALID_ADDRESS = 5, DATA_ACCESS_ERROR_TYPE_UNSUPPORTED = 6, DATA_ACCESS_ERROR_TYPE_INCONSISTENT = 7, DATA_ACCESS_ERROR_OBJECT_ATTRIBUTE_INCONSISTENT = 8, DATA_ACCESS_ERROR_OBJECT_ACCESS_UNSUPPORTED = 9, DATA_ACCESS_ERROR_OBJECT_NONE_EXISTENT = 10, DATA_ACCESS_ERROR_OBJECT_VALUE_INVALID = 11, DATA_ACCESS_ERROR_UNKNOWN = 12 }

Functions
MmsValue *	MmsValue_createArray (MmsVariableSpecification *elementType, int size)
	Create an Array and initialize elements with default values. More...

uint32_t	MmsValue_getArraySize (const MmsValue *self)
	Get the size of an array. More...

MmsValue *	MmsValue_getElement (const MmsValue *array, int index)
	Get an element of an array or structure. More...

MmsValue *	MmsValue_createEmptyArray (int size)
	Create an emtpy array. More...

void	MmsValue_setElement (MmsValue complexValue, int index, MmsValue elementValue)
	Set an element of a complex type. More...

MmsDataAccessError	MmsValue_getDataAccessError (const MmsValue *self)

int64_t	MmsValue_toInt64 (const MmsValue *self)
	Get the int64_t value of a MmsValue object. More...

int32_t	MmsValue_toInt32 (const MmsValue *value)
	Get the int32_t value of a MmsValue object. More...

uint32_t	MmsValue_toUint32 (const MmsValue *value)
	Get the uint32_t value of a MmsValue object. More...

double	MmsValue_toDouble (const MmsValue *self)
	Get the double value of a MmsValue object. More...

float	MmsValue_toFloat (const MmsValue *self)
	Get the float value of a MmsValue object. More...

uint32_t	MmsValue_toUnixTimestamp (const MmsValue *self)
	Get the unix timestamp of a MmsValue object of type MMS_UTCTIME. More...

void	MmsValue_setFloat (MmsValue *self, float newFloatValue)
	Set the float value of a MmsValue object. More...

void	MmsValue_setDouble (MmsValue *self, double newFloatValue)
	Set the double value of a MmsValue object. More...

void	MmsValue_setInt8 (MmsValue *value, int8_t integer)
	Set the Int8 value of a MmsValue object. More...

void	MmsValue_setInt16 (MmsValue *value, int16_t integer)
	Set the Int16 value of a MmsValue object. More...

void	MmsValue_setInt32 (MmsValue *self, int32_t integer)
	Set the Int32 value of a MmsValue object. More...

void	MmsValue_setInt64 (MmsValue *value, int64_t integer)
	Set the Int64 value of a MmsValue object. More...

void	MmsValue_setUint8 (MmsValue *value, uint8_t integer)
	Set the UInt8 value of a MmsValue object. More...

void	MmsValue_setUint16 (MmsValue *value, uint16_t integer)
	Set the UInt16 value of a MmsValue object. More...

void	MmsValue_setUint32 (MmsValue *value, uint32_t integer)
	Set the UInt32 value of a MmsValue object. More...

void	MmsValue_setBoolean (MmsValue *value, bool boolValue)
	Set the bool value of a MmsValue object. More...

bool	MmsValue_getBoolean (const MmsValue *value)
	Get the bool value of a MmsValue object. More...

const char *	MmsValue_toString (MmsValue *self)
	Returns the value of an MMS_VISIBLE_STRING object as C string. More...

int	MmsValue_getStringSize (MmsValue *self)
	Returns the (maximum) length of the string. More...

void	MmsValue_setVisibleString (MmsValue self, const char string)

void	MmsValue_setBitStringBit (MmsValue *self, int bitPos, bool value)
	Set a single bit (set to one) of an MmsType object of type MMS_BITSTRING. More...

bool	MmsValue_getBitStringBit (const MmsValue *self, int bitPos)
	Get the value of a single bit (set to one) of an MmsType object of type MMS_BITSTRING. More...

void	MmsValue_deleteAllBitStringBits (MmsValue *self)
	Delete all bits (set to zero) of an MmsType object of type MMS_BITSTRING. More...

int	MmsValue_getBitStringSize (const MmsValue *self)
	Get the size of a bit string in bits. More...

int	MmsValue_getBitStringByteSize (const MmsValue *self)
	Get the number of bytes required by this bitString. More...

int	MmsValue_getNumberOfSetBits (const MmsValue *self)
	Count the number of set bits in a bit string. More...

void	MmsValue_setAllBitStringBits (MmsValue *self)

uint32_t	MmsValue_getBitStringAsInteger (const MmsValue *self)
	Convert a bit string to an unsigned integer. More...

void	MmsValue_setBitStringFromInteger (MmsValue *self, uint32_t intValue)
	Convert an unsigned integer to a bit string. More...

uint32_t	MmsValue_getBitStringAsIntegerBigEndian (const MmsValue *self)
	Convert a bit string to an unsigned integer (big endian bit order) More...

void	MmsValue_setBitStringFromIntegerBigEndian (MmsValue *self, uint32_t intValue)
	Convert an unsigned integer to a bit string (big endian bit order) More...

MmsValue *	MmsValue_setUtcTime (MmsValue *self, uint32_t timeval)
	Update an MmsValue object of UtcTime type with a timestamp in s. More...

MmsValue *	MmsValue_setUtcTimeMs (MmsValue *self, uint64_t timeval)
	Update an MmsValue object of type MMS_UTCTIME with a millisecond time. More...

void	MmsValue_setUtcTimeByBuffer (MmsValue self, const uint8_t buffer)
	Update an MmsValue object of type MMS_UTCTIME with a buffer containing a BER encoded UTCTime. More...

uint8_t *	MmsValue_getUtcTimeBuffer (MmsValue *self)
	return the raw buffer containing the UTC time data More...

uint64_t	MmsValue_getUtcTimeInMs (const MmsValue *value)
	Get a millisecond time value from an MmsValue object of MMS_UTCTIME type. More...

uint64_t	MmsValue_getUtcTimeInMsWithUs (const MmsValue self, uint32_t usec)
	Get a millisecond time value and optional us part from an MmsValue object of MMS_UTCTIME type. More...

void	MmsValue_setUtcTimeQuality (MmsValue *self, uint8_t timeQuality)
	set the TimeQuality byte of the UtcTime More...

uint8_t	MmsValue_getUtcTimeQuality (const MmsValue *self)
	get the TimeQuality byte of the UtcTime More...

void	MmsValue_setBinaryTime (MmsValue *self, uint64_t timestamp)
	Update an MmsValue object of type MMS_BINARYTIME with a millisecond time. More...

uint64_t	MmsValue_getBinaryTimeAsUtcMs (const MmsValue *self)
	Get a millisecond time value from an MmsValue object of type MMS_BINARYTIME. More...

void	MmsValue_setOctetString (MmsValue self, uint8_t buf, int size)
	Set the value of an MmsValue object of type MMS_OCTET_STRING. More...

uint16_t	MmsValue_getOctetStringSize (const MmsValue *self)
	Returns the size in bytes of an MmsValue object of type MMS_OCTET_STRING. More...

uint16_t	MmsValue_getOctetStringMaxSize (MmsValue *self)
	Returns the maximum size in bytes of an MmsValue object of type MMS_OCTET_STRING. More...

uint8_t *	MmsValue_getOctetStringBuffer (MmsValue *self)
	Returns the reference to the internally hold buffer of an MmsValue object of type MMS_OCTET_STRING. More...

bool	MmsValue_update (MmsValue self, const MmsValue source)
	Update the value of an MmsValue instance by the value of another MmsValue instance. More...

bool	MmsValue_equals (const MmsValue self, const MmsValue otherValue)
	Check if two instances of MmsValue have the same value. More...

bool	MmsValue_equalTypes (const MmsValue self, const MmsValue otherValue)
	Check if two (complex) instances of MmsValue have the same type. More...

MmsValue *	MmsValue_newDataAccessError (MmsDataAccessError accessError)

MmsValue *	MmsValue_newIntegerFromBerInteger (Asn1PrimitiveValue *berInteger)

MmsValue *	MmsValue_newUnsignedFromBerInteger (Asn1PrimitiveValue *berInteger)

MmsValue *	MmsValue_newInteger (int size)

MmsValue *	MmsValue_newUnsigned (int size)

MmsValue *	MmsValue_newBoolean (bool boolean)

MmsValue *	MmsValue_newBitString (int bitSize)
	Create a new MmsValue instance of type MMS_BITSTRING. More...

MmsValue *	MmsValue_newOctetString (int size, int maxSize)

MmsValue *	MmsValue_newStructure (const MmsVariableSpecification *typeSpec)

MmsValue *	MmsValue_createEmptyStructure (int size)

MmsValue *	MmsValue_newDefaultValue (const MmsVariableSpecification *typeSpec)

MmsValue *	MmsValue_newIntegerFromInt8 (int8_t integer)

MmsValue *	MmsValue_newIntegerFromInt16 (int16_t integer)

MmsValue *	MmsValue_newIntegerFromInt32 (int32_t integer)

MmsValue *	MmsValue_newIntegerFromInt64 (int64_t integer)

MmsValue *	MmsValue_newUnsignedFromUint32 (uint32_t integer)

MmsValue *	MmsValue_newFloat (float variable)

MmsValue *	MmsValue_newDouble (double variable)

MmsValue *	MmsValue_clone (const MmsValue *self)
	Create a (deep) copy of an MmsValue instance. More...

uint8_t *	MmsValue_cloneToBuffer (const MmsValue self, uint8_t destinationAddress)
	Create a (deep) copy of an MmsValue instance in a user provided buffer. More...

int	MmsValue_getSizeInMemory (const MmsValue *self)
	Determine the required amount of bytes by a clone. More...

void	MmsValue_delete (MmsValue *self)
	Delete an MmsValue instance. More...

void	MmsValue_deleteConditional (MmsValue *value)
	Delete an MmsValue instance. More...

void	MmsValue_deleteIfNotNull (MmsValue *value)
	Delete an MmsValue instance if the provided pointer is not NULL. More...

MmsValue *	MmsValue_newVisibleString (const char *string)
	Create a new MmsValue instance of type MMS_VISIBLE_STRING. More...

MmsValue *	MmsValue_newVisibleStringWithSize (int size)
	Create a new MmsValue instance of type MMS_VISIBLE_STRING. More...

MmsValue *	MmsValue_newMmsStringWithSize (int size)
	Create a new MmsValue instance of type MMS_STRING. More...

MmsValue *	MmsValue_newBinaryTime (bool timeOfDay)
	Create a new MmsValue instance of type MMS_BINARYTIME. More...

MmsValue *	MmsValue_newVisibleStringFromByteArray (uint8_t *byteArray, int size)
	Create a new MmsValue instance of type MMS_VISIBLE_STRING from the specified byte array. More...

MmsValue *	MmsValue_newMmsStringFromByteArray (uint8_t *byteArray, int size)
	Create a new MmsValue instance of type MMS_STRING from the specified byte array. More...

MmsValue *	MmsValue_newMmsString (char *string)
	Create a new MmsValue instance of type MMS_STRING. More...

void	MmsValue_setMmsString (MmsValue value, const char string)

MmsValue *	MmsValue_newUtcTime (uint32_t timeval)
	Create a new MmsValue instance of type MMS_UTCTIME. More...

MmsValue *	MmsValue_newUtcTimeByMsTime (uint64_t timeval)
	Create a new MmsValue instance of type MMS_UTCTIME. More...

void	MmsValue_setDeletable (MmsValue *self)

void	MmsValue_setDeletableRecursive (MmsValue *value)

int	MmsValue_isDeletable (MmsValue *self)
	Check if the MmsValue instance has the deletable flag set. More...

MmsType	MmsValue_getType (const MmsValue *self)
	Get the MmsType of an MmsValue instance. More...

MmsValue *	MmsValue_getSubElement (MmsValue self, MmsVariableSpecification varSpec, char *mmsPath)
	Get a sub-element of a MMS_STRUCTURE value specified by a path name. More...

char *	MmsValue_getTypeString (MmsValue *self)
	return the value type as a human readable string More...

const char *	MmsValue_printToBuffer (const MmsValue self, char buffer, int bufferSize)
	create a string representation of the MmsValue object in the provided buffer More...

MmsValue *	MmsValue_decodeMmsData (uint8_t buffer, int bufPos, int bufferLength, int endBufPos)
	create a new MmsValue instance from a BER encoded MMS Data element (deserialize) More...

int	MmsValue_encodeMmsData (MmsValue self, uint8_t buffer, int bufPos, bool encode)
	Serialize the MmsValue instance as BER encoded MMS Data element. More...

Detailed Description

Typedef Documentation

typedef struct sMmsValue MmsValue

MmsValue - complex value type for MMS Client API

Enumeration Type Documentation

enum MmsDataAccessError

Enumerator
DATA_ACCESS_ERROR_NO_RESPONSE
DATA_ACCESS_ERROR_SUCCESS
DATA_ACCESS_ERROR_OBJECT_INVALIDATED
DATA_ACCESS_ERROR_HARDWARE_FAULT
DATA_ACCESS_ERROR_TEMPORARILY_UNAVAILABLE
DATA_ACCESS_ERROR_OBJECT_ACCESS_DENIED
DATA_ACCESS_ERROR_OBJECT_UNDEFINED
DATA_ACCESS_ERROR_INVALID_ADDRESS
DATA_ACCESS_ERROR_TYPE_UNSUPPORTED
DATA_ACCESS_ERROR_TYPE_INCONSISTENT
DATA_ACCESS_ERROR_OBJECT_ATTRIBUTE_INCONSISTENT
DATA_ACCESS_ERROR_OBJECT_ACCESS_UNSUPPORTED
DATA_ACCESS_ERROR_OBJECT_NONE_EXISTENT
DATA_ACCESS_ERROR_OBJECT_VALUE_INVALID
DATA_ACCESS_ERROR_UNKNOWN

Function Documentation

MmsValue* MmsValue_clone ( const MmsValue * self )

Create a (deep) copy of an MmsValue instance.

This operation will allocate dynamic memory. It is up to the caller to free this memory by calling MmsValue_delete() later.

Parameters

self	the MmsValue instance that will be cloned

Returns: an MmsValue instance that is an exact copy of the given instance.

uint8_t* MmsValue_cloneToBuffer	(	const MmsValue *	self,
		uint8_t *	destinationAddress
	)

Create a (deep) copy of an MmsValue instance in a user provided buffer.

This operation copies the give MmsValue instance to a user provided buffer.

Parameters

self	the MmsValue instance that will be cloned
destinationAddress	the start address of the user provided buffer

Returns: a pointer to the position in the buffer just after the last byte written.

MmsValue* MmsValue_createArray	(	MmsVariableSpecification *	elementType,
		int	size
	)

Create an Array and initialize elements with default values.

Parameters

elementType	type description for the elements the new array
size	the size of the new array

Returns: a newly created array instance

MmsValue* MmsValue_createEmptyArray ( int size )

Create an emtpy array.

Parameters

size	the size of the new array

Returns: a newly created empty array instance

MmsValue* MmsValue_createEmptyStructure ( int size )

MmsValue* MmsValue_decodeMmsData	(	uint8_t *	buffer,
		int	bufPos,
		int	bufferLength,
		int *	endBufPos
	)

create a new MmsValue instance from a BER encoded MMS Data element (deserialize)

WARNING: API changed with version 1.0.3 (added endBufPos parameter)

Parameters

buffer	the buffer to read from
bufPos	the start position of the mms value data in the buffer
bufferLength	the length of the buffer
endBufPos	the position in the buffer after the read MMS data element (NULL if not required)

Returns: the MmsValue instance created from the buffer

void MmsValue_delete ( MmsValue * self )

Delete an MmsValue instance.

This operation frees all dynamically allocated memory of the MmsValue instance. If the instance is of type MMS_STRUCTURE or MMS_ARRAY all child elements will be deleted too.

Parameters

self	the MmsValue instance to be deleted.

void MmsValue_deleteAllBitStringBits ( MmsValue * self )

Delete all bits (set to zero) of an MmsType object of type MMS_BITSTRING.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BITSTRING.

void MmsValue_deleteConditional ( MmsValue * value )

Delete an MmsValue instance.

This operation frees all dynamically allocated memory of the MmsValue instance. If the instance is of type MMS_STRUCTURE or MMS_ARRAY all child elements will be deleted too.

NOTE: this functions only frees the instance if deleteValue field = 0!

Parameters

self	the MmsValue instance to be deleted.

void MmsValue_deleteIfNotNull ( MmsValue * value )

Delete an MmsValue instance if the provided pointer is not NULL.

This operation frees all dynamically allocated memory of the MmsValue instance. If the instance is of type MMS_STRUCTURE or MMS_ARRAY all child elements will be deleted too.

Parameters

self	the MmsValue instance to be deleted.

int MmsValue_encodeMmsData	(	MmsValue *	self,
		uint8_t *	buffer,
		int	bufPos,
		bool	encode
	)

Serialize the MmsValue instance as BER encoded MMS Data element.

Parameters

self	the MmsValue instance
buffer	the buffer to encode the MMS data element
bufPos	the position in the buffer where to start encoding
encode	encode to buffer (true) or calculate length only (false)

Returns: the encoded length of the corresponding MMS data element

bool MmsValue_equals	(	const MmsValue *	self,
		const MmsValue *	otherValue
	)

Check if two instances of MmsValue have the same value.

Both instances should be of same type. E.g. is self is of type MMS_INTEGER then source has also to be of type MMS_INTEGER. Otherwise the call will return false.

Parameters

self	MmsValue instance to operate on.
otherValue	MmsValue that is used to test

Returns: true if both instances are of the same type and have the same value

bool MmsValue_equalTypes	(	const MmsValue *	self,
		const MmsValue *	otherValue
	)

Check if two (complex) instances of MmsValue have the same type.

This function will test if the two values are of the same type. The function will return true only if all child instances in the MmsValue instance tree are also of equal type.

Parameters

self	MmsValue instance to operate on.
otherValue	MmsValue that is used to test

Returns: true if both instances and all their children are of the same type.

uint32_t MmsValue_getArraySize ( const MmsValue * self )

Get the size of an array.

Parameters

self	MmsValue instance to operate on. Has to be of type MMS_ARRAY.

Returns: the size of the array

uint64_t MmsValue_getBinaryTimeAsUtcMs ( const MmsValue * self )

Get a millisecond time value from an MmsValue object of type MMS_BINARYTIME.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BINARYTIME.

Returns: the value in milliseconds since epoch (1970/01/01 00:00 UTC)

uint32_t MmsValue_getBitStringAsInteger ( const MmsValue * self )

Convert a bit string to an unsigned integer.

This function assumes that the first bit in the bit string is the least significant bit (little endian bit order).

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BITSTRING.

uint32_t MmsValue_getBitStringAsIntegerBigEndian ( const MmsValue * self )

Convert a bit string to an unsigned integer (big endian bit order)

This function assumes that the first bit in the bit string is the most significant bit (big endian bit order).

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BITSTRING.

bool MmsValue_getBitStringBit	(	const MmsValue *	self,
		int	bitPos
	)

Get the value of a single bit (set to one) of an MmsType object of type MMS_BITSTRING.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BITSTRING.
bitPos	the position of the bit in the bit string. Starting with 0. The bit with position 0 is the first bit if the MmsValue instance is serialized.

Returns: the value of the bit (true = 1 / false = 0)

int MmsValue_getBitStringByteSize ( const MmsValue * self )

Get the number of bytes required by this bitString.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BITSTRING.

int MmsValue_getBitStringSize ( const MmsValue * self )

Get the size of a bit string in bits.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BITSTRING.

bool MmsValue_getBoolean ( const MmsValue * value )

Get the bool value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BOOLEAN.

Returns: the MmsValue value as bool value

MmsDataAccessError MmsValue_getDataAccessError ( const MmsValue * self )

MmsValue* MmsValue_getElement	(	const MmsValue *	array,
		int	index
	)

Get an element of an array or structure.

Parameters

self	MmsValue instance to operate on. Has to be of type MMS_ARRAY or MMS_STRUCTURE.
index	ndex of the requested array or structure element

Returns: the element object

int MmsValue_getNumberOfSetBits ( const MmsValue * self )

Count the number of set bits in a bit string.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BITSTRING.

uint8_t* MmsValue_getOctetStringBuffer ( MmsValue * self )

Returns the reference to the internally hold buffer of an MmsValue object of type MMS_OCTET_STRING.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_OCTET_STRING.

Returns: reference to the buffer

uint16_t MmsValue_getOctetStringMaxSize ( MmsValue * self )

Returns the maximum size in bytes of an MmsValue object of type MMS_OCTET_STRING.

Returns the maximum size if bytes of the MmsValue object of type MMS_OCTET_STRING. This is the size of the internally allocated buffer to hold the octet string data.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_OCTET_STRING.

Returns: maximum size in bytes

uint16_t MmsValue_getOctetStringSize ( const MmsValue * self )

Returns the size in bytes of an MmsValue object of type MMS_OCTET_STRING.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_OCTET_STRING.

Returns: size in bytes

int MmsValue_getSizeInMemory ( const MmsValue * self )

Determine the required amount of bytes by a clone.

This function is intended to be used to determine the buffer size of a clone operation (MmsValue_cloneToBuffer) in advance.

Parameters

self	the MmsValue instance

Returns: the number of bytes required by a clone

int MmsValue_getStringSize ( MmsValue * self )

Returns the (maximum) length of the string.

NOTE: this function return the amount of memory allocated for the string buffer - 1.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_VISIBLE_STRING or MMS_STRING.

MmsValue* MmsValue_getSubElement	(	MmsValue *	self,
		MmsVariableSpecification *	varSpec,
		char *	mmsPath
	)

Get a sub-element of a MMS_STRUCTURE value specified by a path name.

Parameters

self	the MmsValue instance
varSpec	- type specification if the MMS_STRUCTURE value
mmsPath	- path (in MMS variable name syntax) to specify the sub element.

Returns: the sub elements MmsValue instance or NULL if the element does not exist

MmsType MmsValue_getType ( const MmsValue * self )

Get the MmsType of an MmsValue instance.

Parameters

self	the MmsValue instance

char* MmsValue_getTypeString ( MmsValue * self )

return the value type as a human readable string

Parameters

self	the MmsValue instance

Returns: the value type as a human readable string

uint8_t* MmsValue_getUtcTimeBuffer ( MmsValue * self )

return the raw buffer containing the UTC time data

Note: This will return the address of the raw byte buffer. The array length is 8 byte.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_UTCTIME.

Returns: the buffer containing the raw data

uint64_t MmsValue_getUtcTimeInMs ( const MmsValue * value )

Get a millisecond time value from an MmsValue object of MMS_UTCTIME type.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_UTCTIME.

Returns: the value in milliseconds since epoch (1970/01/01 00:00 UTC)

uint64_t MmsValue_getUtcTimeInMsWithUs	(	const MmsValue *	self,
		uint32_t *	usec
	)

Get a millisecond time value and optional us part from an MmsValue object of MMS_UTCTIME type.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_UTCTIME.
usec	a pointer to store the us (microsecond) value.

Returns: the value in milliseconds since epoch (1970/01/01 00:00 UTC)

uint8_t MmsValue_getUtcTimeQuality ( const MmsValue * self )

get the TimeQuality byte of the UtcTime

Meaning of the bits in the timeQuality byte:

bit 7 = leapSecondsKnown bit 6 = clockFailure bit 5 = clockNotSynchronized bit 0-4 = subsecond time accuracy (number of significant bits of subsecond time)

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_UTCTIME.

Returns: the byte representing the time quality

int MmsValue_isDeletable ( MmsValue * self )

Check if the MmsValue instance has the deletable flag set.

The deletable flag indicates if an libiec61850 API client should call the MmsValue_delete() method or not if the MmsValue instance was passed to the client by an API call or callback method.

Parameters

self	the MmsValue instance

Returns: 1 if deletable flag is set, otherwise 0

MmsValue* MmsValue_newBinaryTime ( bool timeOfDay )

Create a new MmsValue instance of type MMS_BINARYTIME.

If the timeOfDay parameter is set to true then the resulting MMS_BINARYTIME object is only 4 octets long and includes only the seconds since midnight. Otherwise the MMS_BINARYTIME

Parameters

timeOfDay if true only the TimeOfDay value is included.

Returns: new MmsValue instance of type MMS_BINARYTIME

MmsValue* MmsValue_newBitString ( int bitSize )

Create a new MmsValue instance of type MMS_BITSTRING.

Parameters

bitSize the size of the bit string in bit

Returns: new MmsValue instance of type MMS_BITSTRING

MmsValue* MmsValue_newBoolean ( bool boolean )

MmsValue* MmsValue_newDataAccessError ( MmsDataAccessError accessError )

MmsValue* MmsValue_newDefaultValue ( const MmsVariableSpecification * typeSpec )

MmsValue* MmsValue_newDouble ( double variable )

MmsValue* MmsValue_newFloat ( float variable )

MmsValue* MmsValue_newInteger ( int size )

MmsValue* MmsValue_newIntegerFromBerInteger ( Asn1PrimitiveValue * berInteger )

MmsValue* MmsValue_newIntegerFromInt16 ( int16_t integer )

MmsValue* MmsValue_newIntegerFromInt32 ( int32_t integer )

MmsValue* MmsValue_newIntegerFromInt64 ( int64_t integer )

MmsValue* MmsValue_newIntegerFromInt8 ( int8_t integer )

MmsValue* MmsValue_newMmsString ( char * string )

Create a new MmsValue instance of type MMS_STRING.

Parameters

string a text string that should be the value of the new instance of NULL for an empty string.

Returns: new MmsValue instance of type MMS_STRING

MmsValue* MmsValue_newMmsStringFromByteArray	(	uint8_t *	byteArray,
		int	size
	)

Create a new MmsValue instance of type MMS_STRING from the specified byte array.

Parameters

byteArray	the byte array containing the string data
size	the size of the byte array

Returns: new MmsValue instance of type MMS_STRING

MmsValue* MmsValue_newMmsStringWithSize ( int size )

Create a new MmsValue instance of type MMS_STRING.

This function will create a new empty MmsValue string object. The maximum size of the string is set according to the size parameter. The function allocates as much memory as is required to hold a string of the maximum size.

Parameters

size	the new maximum size of the string.

Returns: new MmsValue instance of type MMS_STRING

MmsValue* MmsValue_newOctetString	(	int	size,
		int	maxSize
	)

MmsValue* MmsValue_newStructure ( const MmsVariableSpecification * typeSpec )

MmsValue* MmsValue_newUnsigned ( int size )

MmsValue* MmsValue_newUnsignedFromBerInteger ( Asn1PrimitiveValue * berInteger )

MmsValue* MmsValue_newUnsignedFromUint32 ( uint32_t integer )

MmsValue* MmsValue_newUtcTime ( uint32_t timeval )

Create a new MmsValue instance of type MMS_UTCTIME.

Parameters

timeval time value as UNIX timestamp (seconds since epoch)

Returns: new MmsValue instance of type MMS_UTCTIME

MmsValue* MmsValue_newUtcTimeByMsTime ( uint64_t timeval )

Create a new MmsValue instance of type MMS_UTCTIME.

Parameters

timeval time value as millisecond timestamp (milliseconds since epoch)

Returns: new MmsValue instance of type MMS_UTCTIME

MmsValue* MmsValue_newVisibleString ( const char * string )

Create a new MmsValue instance of type MMS_VISIBLE_STRING.

This function will allocate as much memory as required to hold the string and sets the maximum size of the string to this size.

Parameters

string a text string that should be the value of the new instance of NULL for an empty string.

Returns: new MmsValue instance of type MMS_VISIBLE_STRING

MmsValue* MmsValue_newVisibleStringFromByteArray	(	uint8_t *	byteArray,
		int	size
	)

Create a new MmsValue instance of type MMS_VISIBLE_STRING from the specified byte array.

Parameters

byteArray	the byte array containing the string data
size	the size of the byte array

Returns: new MmsValue instance of type MMS_VISIBLE_STRING

MmsValue* MmsValue_newVisibleStringWithSize ( int size )

Create a new MmsValue instance of type MMS_VISIBLE_STRING.

This function will create a new empty MmsValue string object. The maximum size of the string is set according to the size parameter. The function allocates as much memory as is required to hold a string of the maximum size.

Parameters

size	the new maximum size of the string.

Returns: new MmsValue instance of type MMS_VISIBLE_STRING

const char* MmsValue_printToBuffer	(	const MmsValue *	self,
		char *	buffer,
		int	bufferSize
	)

create a string representation of the MmsValue object in the provided buffer

NOTE: This function is for debugging purposes only. It may not be aimed to be used in embedded systems. It requires a full featured snprintf function.

Parameters

self	the MmsValue instance
buffer	the buffer where to copy the string representation
bufferSize	the size of the provided buffer

Returns: a pointer to the start of the buffer

void MmsValue_setAllBitStringBits ( MmsValue * self )

Set all bits (set to one) of an MmsType object of type MMS_BITSTRING

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BITSTRING.

void MmsValue_setBinaryTime	(	MmsValue *	self,
		uint64_t	timestamp
	)

Update an MmsValue object of type MMS_BINARYTIME with a millisecond time.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_UTCTIME.
timeval	the new value in milliseconds since epoch (1970/01/01 00:00 UTC)

void MmsValue_setBitStringBit	(	MmsValue *	self,
		int	bitPos,
		bool	value
	)

Set a single bit (set to one) of an MmsType object of type MMS_BITSTRING.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BITSTRING.
bitPos	the position of the bit in the bit string. Starting with 0. The bit with position 0 is the first bit if the MmsValue instance is serialized.
value	the new value of the bit (true = 1 / false = 0)

void MmsValue_setBitStringFromInteger	(	MmsValue *	self,
		uint32_t	intValue
	)

Convert an unsigned integer to a bit string.

The integer representation in the bit string assumes the first bit is the least significant bit (little endian bit order).

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BITSTRING.
intValue	the integer value that is used to set the bit string

void MmsValue_setBitStringFromIntegerBigEndian	(	MmsValue *	self,
		uint32_t	intValue
	)

Convert an unsigned integer to a bit string (big endian bit order)

The integer representation in the bit string assumes the first bit is the most significant bit (big endian bit order).

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BITSTRING.
intValue	the integer value that is used to set the bit string

void MmsValue_setBoolean	(	MmsValue *	value,
		bool	boolValue
	)

Set the bool value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BOOLEAN.
boolValue	a bool value

void MmsValue_setDeletable ( MmsValue * self )

void MmsValue_setDeletableRecursive ( MmsValue * value )

void MmsValue_setDouble	(	MmsValue *	self,
		double	newFloatValue
	)

Set the double value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_FLOAT.

void MmsValue_setElement	(	MmsValue *	complexValue,
		int	index,
		MmsValue *	elementValue
	)

Set an element of a complex type.

NOTE: If the element already exists it will simply be replaced by the provided new value. The caller is responsible to free the replaced value.

Parameters

complexValue	MmsValue instance to operate on. Has to be of a type MMS_STRUCTURE or MMS_ARRAY
the	index of the element to set/replace
elementValue	the (new) value of the element

void MmsValue_setFloat	(	MmsValue *	self,
		float	newFloatValue
	)

Set the float value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_FLOAT.

void MmsValue_setInt16	(	MmsValue *	value,
		int16_t	integer
	)

Set the Int16 value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_INTEGER.
integer	the new value to set

void MmsValue_setInt32	(	MmsValue *	self,
		int32_t	integer
	)

Set the Int32 value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_INTEGER.
integer	the new value to set

void MmsValue_setInt64	(	MmsValue *	value,
		int64_t	integer
	)

Set the Int64 value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_INTEGER.
integer	the new value to set

void MmsValue_setInt8	(	MmsValue *	value,
		int8_t	integer
	)

Set the Int8 value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_INTEGER.
integer	the new value to set

void MmsValue_setMmsString	(	MmsValue *	value,
		const char *	string
	)

void MmsValue_setOctetString	(	MmsValue *	self,
		uint8_t *	buf,
		int	size
	)

Set the value of an MmsValue object of type MMS_OCTET_STRING.

This method will copy the provided buffer to the internal buffer of the MmsValue instance. This will only happen if the internal buffer size is large enough for the new value.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_OCTET_STRING.
buf	the buffer that contains the new value
size	the size of the buffer that contains the new value

void MmsValue_setUint16	(	MmsValue *	value,
		uint16_t	integer
	)

Set the UInt16 value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_UNSIGNED.
integer	the new value to set

void MmsValue_setUint32	(	MmsValue *	value,
		uint32_t	integer
	)

Set the UInt32 value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_UNSIGNED.
integer	the new value to set

void MmsValue_setUint8	(	MmsValue *	value,
		uint8_t	integer
	)

Set the UInt8 value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_UNSIGNED.
integer	the new value to set

MmsValue* MmsValue_setUtcTime	(	MmsValue *	self,
		uint32_t	timeval
	)

Update an MmsValue object of UtcTime type with a timestamp in s.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_BOOLEAN.
timeval	the new value in seconds since epoch (1970/01/01 00:00 UTC)

void MmsValue_setUtcTimeByBuffer	(	MmsValue *	self,
		const uint8_t *	buffer
	)

Update an MmsValue object of type MMS_UTCTIME with a buffer containing a BER encoded UTCTime.

The buffer must have a size of 8 bytes!

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_UTCTIME.
buffer	buffer containing the encoded UTCTime.

MmsValue* MmsValue_setUtcTimeMs	(	MmsValue *	self,
		uint64_t	timeval
	)

Update an MmsValue object of type MMS_UTCTIME with a millisecond time.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_UTCTIME.
timeval	the new value in milliseconds since epoch (1970/01/01 00:00 UTC)

void MmsValue_setUtcTimeQuality	(	MmsValue *	self,
		uint8_t	timeQuality
	)

set the TimeQuality byte of the UtcTime

Meaning of the bits in the timeQuality byte:

bit 7 = leapSecondsKnown bit 6 = clockFailure bit 5 = clockNotSynchronized bit 0-4 = subsecond time accuracy (number of significant bits of subsecond time)

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_UTCTIME.
timeQuality	the byte representing the time quality

void MmsValue_setVisibleString	(	MmsValue *	self,
		const char *	string
	)

double MmsValue_toDouble ( const MmsValue * self )

Get the double value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of type MMS_FLOAT.

Returns: 64 bit floating point value

float MmsValue_toFloat ( const MmsValue * self )

Get the float value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of type MMS_FLOAT.

Returns: 32 bit floating point value

int32_t MmsValue_toInt32 ( const MmsValue * value )

Get the int32_t value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_INTEGER or MMS_UNSIGNED

Returns: signed 32 bit integer

int64_t MmsValue_toInt64 ( const MmsValue * self )

Get the int64_t value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_INTEGER or MMS_UNSIGNED

Returns: signed 64 bit integer

const char* MmsValue_toString ( MmsValue * self )

Returns the value of an MMS_VISIBLE_STRING object as C string.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_VISIBLE_STRING or MMS_STRING.

Returns: the string value as 0 terminated C string

uint32_t MmsValue_toUint32 ( const MmsValue * value )

Get the uint32_t value of a MmsValue object.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_INTEGER or MMS_UNSIGNED

Returns: unsigned 32 bit integer

uint32_t MmsValue_toUnixTimestamp ( const MmsValue * self )

Get the unix timestamp of a MmsValue object of type MMS_UTCTIME.

Parameters

self	MmsValue instance to operate on. Has to be of a type MMS_UTC_TIME.

Returns: unix timestamp of the MMS_UTCTIME variable.

bool MmsValue_update	(	MmsValue *	self,
		const MmsValue *	source
	)

Update the value of an MmsValue instance by the value of another MmsValue instance.

Both instances should be of same time. E.g. is self is of type MMS_INTEGER then source has also to be of type MMS_INTEGER. Otherwise the call will have no effect.

Parameters

self	MmsValue instance to operate on.
source	MmsValue used as source for the update. Has to be of same type as self

Returns: indicates if the update has been successful (false if not)

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation