libiec61850  1.2.0
Macros | Typedefs | Functions
Client side SV control block handling functions

Macros

#define IEC61850_SV_OPT_REFRESH_TIME   1
 
#define IEC61850_SV_OPT_SAMPLE_SYNC   2
 
#define IEC61850_SV_OPT_SAMPLE_RATE   4
 
#define IEC61850_SV_OPT_DATA_SET   8
 
#define IEC61850_SV_OPT_SECURITY   16
 
#define IEC61850_SV_SMPMOD_SAMPLES_PER_PERIOD   0
 
#define IEC61850_SV_SMPMOD_SAMPLES_PER_SECOND   1
 
#define IEC61850_SV_SMPMOD_SECONDS_PER_SAMPLE   2
 

Typedefs

typedef struct sClientSVControlBlock * ClientSVControlBlock
 

Functions

ClientSVControlBlock ClientSVControlBlock_create (IedConnection connection, const char *reference)
 Create a new ClientSVControlBlock instance. More...
 
void ClientSVControlBlock_destroy (ClientSVControlBlock self)
 Free all resources related to the ClientSVControlBlock instance. More...
 
bool ClientSVControlBlock_isMulticast (ClientSVControlBlock self)
 
IedClientError ClientSVControlBlock_getLastComError (ClientSVControlBlock self)
 Return the error code of the last write or write acccess to the SVCB. More...
 
bool ClientSVControlBlock_setSvEna (ClientSVControlBlock self, bool value)
 
bool ClientSVControlBlock_getSvEna (ClientSVControlBlock self)
 
bool ClientSVControlBlock_setResv (ClientSVControlBlock self, bool value)
 
bool ClientSVControlBlock_getResv (ClientSVControlBlock self)
 
char * ClientSVControlBlock_getMsvID (ClientSVControlBlock self)
 
char * ClientSVControlBlock_getDatSet (ClientSVControlBlock self)
 Get the (MMS) reference to the data set. More...
 
uint32_t ClientSVControlBlock_getConfRev (ClientSVControlBlock self)
 
uint16_t ClientSVControlBlock_getSmpRate (ClientSVControlBlock self)
 
PhyComAddress ClientSVControlBlock_getDstAddress (ClientSVControlBlock self)
 returns the destination address of the SV publisher More...
 
int ClientSVControlBlock_getOptFlds (ClientSVControlBlock self)
 returns the OptFlds bit string as integer More...
 
uint8_t ClientSVControlBlock_getSmpMod (ClientSVControlBlock self)
 returns number of sample mode of the SV publisher More...
 
int ClientSVControlBlock_getNoASDU (ClientSVControlBlock self)
 returns number of ASDUs included in the SV message More...
 

Detailed Description

Macro Definition Documentation

#define IEC61850_SV_OPT_DATA_SET   8

SV ASDU contains attribute DatSet

#define IEC61850_SV_OPT_REFRESH_TIME   1

SV ASDU contains attribute RefrTm

#define IEC61850_SV_OPT_SAMPLE_RATE   4

SV ASDU contains attribute SmpRate

#define IEC61850_SV_OPT_SAMPLE_SYNC   2

SV ASDU contains attribute SmpSynch

#define IEC61850_SV_OPT_SECURITY   16

SV ASDU contains attribute Security

#define IEC61850_SV_SMPMOD_SAMPLES_PER_PERIOD   0
#define IEC61850_SV_SMPMOD_SAMPLES_PER_SECOND   1
#define IEC61850_SV_SMPMOD_SECONDS_PER_SAMPLE   2

Typedef Documentation

typedef struct sClientSVControlBlock* ClientSVControlBlock

an opaque handle to the instance data of a ClientSVControlBlock object

Function Documentation

ClientSVControlBlock ClientSVControlBlock_create ( IedConnection  connection,
const char *  reference 
)

Create a new ClientSVControlBlock instance.

This function simplifies client side access to server MSV/USV control blocks NOTE: Do not use the functions after the IedConnection object is invalidated!

Parameters
connectionthe IedConnection object with a valid connection to the server.
referencethe object reference of the control block
Returns
the new instance
void ClientSVControlBlock_destroy ( ClientSVControlBlock  self)

Free all resources related to the ClientSVControlBlock instance.

Parameters
selfthe ClientSVControlBlock instance to operate on
uint32_t ClientSVControlBlock_getConfRev ( ClientSVControlBlock  self)
char* ClientSVControlBlock_getDatSet ( ClientSVControlBlock  self)

Get the (MMS) reference to the data set.

NOTE: the returned string is dynamically allocated with the GLOBAL_MALLOC macro. The application is responsible to release the memory when the string is no longer needed.

Parameters
selfthe ClientSVControlBlock instance to operate on
Returns
the data set reference as a NULL terminated string
PhyComAddress ClientSVControlBlock_getDstAddress ( ClientSVControlBlock  self)

returns the destination address of the SV publisher

Parameters
selfthe ClientSVControlBlock instance to operate on
IedClientError ClientSVControlBlock_getLastComError ( ClientSVControlBlock  self)

Return the error code of the last write or write acccess to the SVCB.

Parameters
selfthe ClientSVControlBlock instance to operate on
Returns
the error code of the last read or write access
char* ClientSVControlBlock_getMsvID ( ClientSVControlBlock  self)
int ClientSVControlBlock_getNoASDU ( ClientSVControlBlock  self)

returns number of ASDUs included in the SV message

Parameters
selfthe ClientSVControlBlock instance to operate on
int ClientSVControlBlock_getOptFlds ( ClientSVControlBlock  self)

returns the OptFlds bit string as integer

Parameters
selfthe ClientSVControlBlock instance to operate on
bool ClientSVControlBlock_getResv ( ClientSVControlBlock  self)
uint8_t ClientSVControlBlock_getSmpMod ( ClientSVControlBlock  self)

returns number of sample mode of the SV publisher

Parameters
selfthe ClientSVControlBlock instance to operate on
uint16_t ClientSVControlBlock_getSmpRate ( ClientSVControlBlock  self)
bool ClientSVControlBlock_getSvEna ( ClientSVControlBlock  self)
bool ClientSVControlBlock_isMulticast ( ClientSVControlBlock  self)
bool ClientSVControlBlock_setResv ( ClientSVControlBlock  self,
bool  value 
)
bool ClientSVControlBlock_setSvEna ( ClientSVControlBlock  self,
bool  value 
)