libIEC61850  0.8.2
Open-source IEC 61850 MMS/GOOSE server and client library
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Functions
MmsVariableSpecification data type specifications

Functions

void MmsVariableSpecification_destroy (MmsVariableSpecification *self)
 Delete MmsTypeSpecification object (recursive). More...
 
MmsValueMmsVariableSpecification_getChildValue (MmsVariableSpecification *self, MmsValue *value, const char *childId)
 Get the corresponding child of value according to childId. More...
 
MmsVariableSpecification * MmsVariableSpecification_getNamedVariableRecursive (MmsVariableSpecification *self, const char *nameId)
 Get the child of self specified by its relative name. More...
 
MmsType MmsVariableSpecification_getType (MmsVariableSpecification *self)
 get the MMS type of the variable More...
 
const char * MmsVariableSpecification_getName (MmsVariableSpecification *self)
 get the name of the variable More...
 
LinkedList MmsVariableSpecification_getStructureElements (MmsVariableSpecification *self)
 
int MmsVariableSpecification_getSize (MmsVariableSpecification *self)
 returns the number of elements if the type is a complex type (structure, array) or the bit size of integers, unsigned integers, floats, bit strings, visible and MMS strings and octet strings. More...
 
MmsVariableSpecification * MmsVariableSpecification_getChildSpecificationByIndex (MmsVariableSpecification *self, int index)
 
MmsVariableSpecification * MmsVariableSpecification_getArrayElementSpecification (MmsVariableSpecification *self)
 
int MmsVariableSpecification_getExponentWidth (MmsVariableSpecification *self)
 

Detailed Description

Function Documentation

void MmsVariableSpecification_destroy ( MmsVariableSpecification *  self)

Delete MmsTypeSpecification object (recursive).

Parameters
selfthe MmsVariableSpecification instance
MmsVariableSpecification* MmsVariableSpecification_getArrayElementSpecification ( MmsVariableSpecification *  self)
MmsVariableSpecification* MmsVariableSpecification_getChildSpecificationByIndex ( MmsVariableSpecification *  self,
int  index 
)
MmsValue* MmsVariableSpecification_getChildValue ( MmsVariableSpecification *  self,
MmsValue value,
const char *  childId 
)

Get the corresponding child of value according to childId.

This function assumes that value is the corresponding value of the MMS variable self. Given the relative name of a child of self this function returns the corresponding child of the value object. Note: the child name has to be provided in MMS mapping syntax (with "$" sign as separator between path name elements!

Parameters
selfthe MmsVariableSpecification instance
valuethe MmsValue instance
childIdthe relative MMS name to the child MMS variable (with "$" separators!)
int MmsVariableSpecification_getExponentWidth ( MmsVariableSpecification *  self)
const char* MmsVariableSpecification_getName ( MmsVariableSpecification *  self)

get the name of the variable

Note: the return string is only valid as long as the MmsVariableSpecification instance exists!

Parameters
selfthe MmsVariableSpecification instance
Returns
the name of the variable
MmsVariableSpecification* MmsVariableSpecification_getNamedVariableRecursive ( MmsVariableSpecification *  self,
const char *  nameId 
)

Get the child of self specified by its relative name.

Parameters
selfthe MmsVariableSpecification instance
nameIdthe relative MMS name to the child MMS variable (with "$" separators!)
Returns
the variable specification of the child or NULL if not existing.
int MmsVariableSpecification_getSize ( MmsVariableSpecification *  self)

returns the number of elements if the type is a complex type (structure, array) or the bit size of integers, unsigned integers, floats, bit strings, visible and MMS strings and octet strings.

Parameters
selfthe MmsVariableSpecification object
Returns
the number of elements or -1 if not applicable
LinkedList MmsVariableSpecification_getStructureElements ( MmsVariableSpecification *  self)
MmsType MmsVariableSpecification_getType ( MmsVariableSpecification *  self)

get the MMS type of the variable

Parameters
selfthe MmsVariableSpecification instance
Returns
the MMS type of the variable