libIEC61850
Open-source IEC 61850 MMS server and client library
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Functions
IEC 61850 API common parts

Functions

MmsValue * MmsValue_createArray (MmsTypeSpecification *elementType, int size)
 
uint32_t MmsValue_getArraySize (MmsValue *self)
 
MmsValue * MmsValue_getElement (MmsValue *array, int index)
 
MmsValue * MmsValue_createEmtpyArray (int size)
 
void MmsValue_setArrayElement (MmsValue *array, int index, MmsValue *elementValue)
 
MmsValue * MmsValue_getStructElementByIndex (MmsValue *structure, int index)
 
int64_t MmsValue_toInt64 (MmsValue *self)
 
int32_t MmsValue_toInt32 (MmsValue *value)
 
uint32_t MmsValue_toUint32 (MmsValue *value)
 
double MmsValue_toDouble (MmsValue *self)
 
float MmsValue_toFloat (MmsValue *self)
 
uint32_t MmsValue_toUnixTimestamp (MmsValue *self)
 
void MmsValue_setFloat (MmsValue *self, float newFloatValue)
 
void MmsValue_setDouble (MmsValue *self, double newFloatValue)
 
void MmsValue_setInt32 (MmsValue *self, int32_t integer)
 
void MmsValue_setBoolean (MmsValue *value, bool boolValue)
 
char * MmsValue_toString (MmsValue *self)
 
void MmsValue_setVisibleString (MmsValue *self, char *string)
 
void MmsValue_setBitStringBit (MmsValue *self, int bitPos, bool value)
 
bool MmsValue_getBitStringBit (MmsValue *self, int bitPos)
 
void MmsValue_deleteAllBitStringBits (MmsValue *self)
 
void MmsValue_setAllBitStringBits (MmsValue *self)
 
MmsValue * MmsValue_setUtcTime (MmsValue *self, uint32_t timeval)
 
bool MmsValue_update (MmsValue *self, MmsValue *)
 
MmsValue * MmsValue_newDataAccessError (uint32_t code)
 
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)
 
MmsValue * MmsValue_newOctetString (int size, int maxSize)
 
MmsValue * MmsValue_newStructure (MmsTypeSpecification *typeSpec)
 
MmsValue * MmsValue_newDefaultValue (MmsTypeSpecification *typeSpec)
 
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 (MmsValue *value)
 
void MmsValue_delete (MmsValue *value)
 
MmsValue * MmsValue_newVisibleString (char *string)
 
MmsValue * MmsValue_newBinaryTime (bool timeOfDay)
 
MmsValue * MmsValue_newVisibleStringFromByteArray (uint8_t *byteArray, int size)
 
MmsValue * MmsValue_newMmsString (char *string)
 
void MmsValue_setMmsString (MmsValue *value, char *string)
 
MmsValue * MmsValue_newUtcTime (uint32_t timeval)
 
void MmsValue_setDeletable (MmsValue *value)
 
int MmsValue_isDeletable (MmsValue *value)
 
MmsType MmsValue_getType (MmsValue *value)
 

Detailed Description

Function Documentation

MmsValue* MmsValue_clone ( MmsValue *  value)
MmsValue* MmsValue_createArray ( MmsTypeSpecification *  elementType,
int  size 
)

Create an Array and initialize elements with default values.

Parameters
elementTypetype description for the elements the new array
sizethe size of the new array
Returns
a newly created array instance
MmsValue* MmsValue_createEmtpyArray ( int  size)

Create an emtpy array.

Parameters
sizethe size of the new array
Returns
a newly created empty array instance
void MmsValue_delete ( MmsValue *  value)
void MmsValue_deleteAllBitStringBits ( MmsValue *  self)
uint32_t MmsValue_getArraySize ( MmsValue *  self)

Get the size of an array.

Parameters
selfMmsValue instance to operate on. Has to be of type MMS_ARRAY.
Returns
the size of the array
bool MmsValue_getBitStringBit ( MmsValue *  self,
int  bitPos 
)
MmsValue* MmsValue_getElement ( MmsValue *  array,
int  index 
)

Get an element of an array.

Parameters
selfMmsValue instance to operate on. Has to be of type MMS_ARRAY.
indexarray index of the requested array element
Returns
the array element object
MmsValue* MmsValue_getStructElementByIndex ( MmsValue *  structure,
int  index 
)
MmsType MmsValue_getType ( MmsValue *  value)
int MmsValue_isDeletable ( MmsValue *  value)
MmsValue* MmsValue_newBinaryTime ( bool  timeOfDay)
MmsValue* MmsValue_newBitString ( int  bitSize)
MmsValue* MmsValue_newBoolean ( bool  boolean)
MmsValue* MmsValue_newDataAccessError ( uint32_t  code)
MmsValue* MmsValue_newDefaultValue ( MmsTypeSpecification *  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_newMmsString ( char *  string)
MmsValue* MmsValue_newOctetString ( int  size,
int  maxSize 
)
MmsValue* MmsValue_newStructure ( MmsTypeSpecification *  typeSpec)
MmsValue* MmsValue_newUnsigned ( int  size)
MmsValue* MmsValue_newUnsignedFromBerInteger ( Asn1PrimitiveValue *  berInteger)
MmsValue* MmsValue_newUnsignedFromUint32 ( uint32_t  integer)
MmsValue* MmsValue_newUtcTime ( uint32_t  timeval)
MmsValue* MmsValue_newVisibleString ( char *  string)
MmsValue* MmsValue_newVisibleStringFromByteArray ( uint8_t *  byteArray,
int  size 
)
void MmsValue_setAllBitStringBits ( MmsValue *  self)
void MmsValue_setArrayElement ( MmsValue *  array,
int  index,
MmsValue *  elementValue 
)
void MmsValue_setBitStringBit ( MmsValue *  self,
int  bitPos,
bool  value 
)
void MmsValue_setBoolean ( MmsValue *  value,
bool  boolValue 
)

Set the bool value of a MmsValue object.

Parameters
selfMmsValue instance to operate on. Has to be of a type MMS_BOOLEAN.
boolValiea bool value
void MmsValue_setDeletable ( MmsValue *  value)
void MmsValue_setDouble ( MmsValue *  self,
double  newFloatValue 
)

Set the double value of a MmsValue object.

Parameters
selfMmsValue instance to operate on. Has to be of a type MMS_FLOAT.
void MmsValue_setFloat ( MmsValue *  self,
float  newFloatValue 
)

Set the float value of a MmsValue object.

Parameters
selfMmsValue instance to operate on. Has to be of a type MMS_FLOAT.
void MmsValue_setInt32 ( MmsValue *  self,
int32_t  integer 
)

Set the Int32 value of a MmsValue object.

Parameters
selfMmsValue instance to operate on. Has to be of a type MMS_INTEGER.
void MmsValue_setMmsString ( MmsValue *  value,
char *  string 
)
MmsValue* MmsValue_setUtcTime ( MmsValue *  self,
uint32_t  timeval 
)
void MmsValue_setVisibleString ( MmsValue *  self,
char *  string 
)
double MmsValue_toDouble ( MmsValue *  self)

Get the double value of a MmsValue object.

Parameters
selfMmsValue instance to operate on. Has to be of type MMS_FLOAT.
Returns
64 bit floating point value
float MmsValue_toFloat ( MmsValue *  self)

Get the float value of a MmsValue object.

Parameters
selfMmsValue instance to operate on. Has to be of type MMS_FLOAT.
Returns
32 bit floating point value
int32_t MmsValue_toInt32 ( MmsValue *  value)

Get the int32_t value of a MmsValue object.

Parameters
selfMmsValue instance to operate on. Has to be of a type MMS_INTEGER or MMS_UNSIGNED
Returns
signed 32 bit integer
int64_t MmsValue_toInt64 ( MmsValue *  self)

Get the int64_t value of a MmsValue object.

Parameters
selfMmsValue instance to operate on. Has to be of a type MMS_INTEGER or MMS_UNSIGNED
Returns
signed 64 bit integer
char* MmsValue_toString ( MmsValue *  self)
uint32_t MmsValue_toUint32 ( MmsValue *  value)

Get the uint32_t value of a MmsValue object.

Parameters
selfMmsValue instance to operate on. Has to be of a type MMS_INTEGER or MMS_UNSIGNED
Returns
unsigned 32 bit integer
uint32_t MmsValue_toUnixTimestamp ( MmsValue *  self)

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

Parameters
selfMmsValue 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,
MmsValue *   
)