libiec61850  1.2.0
Modules | Macros | Functions
Values Application Service Data Unit (ASDU)
IEC 61850 Sampled Values (SV) subscriber API

Modules

 Deprecated API
 

Macros

#define DEPRECATED
 

Functions

uint16_t SVSubscriber_ASDU_getSmpCnt (SVSubscriber_ASDU self)
 return the SmpCnt value included in the SV ASDU More...
 
const char * SVSubscriber_ASDU_getSvId (SVSubscriber_ASDU self)
 return the SvID value included in the SV ASDU More...
 
const char * SVSubscriber_ASDU_getDatSet (SVSubscriber_ASDU self)
 return the DatSet value included in the SV ASDU More...
 
uint32_t SVSubscriber_ASDU_getConfRev (SVSubscriber_ASDU self)
 return the ConfRev value included in the SV ASDU More...
 
uint8_t SVSubscriber_ASDU_getSmpMod (SVSubscriber_ASDU self)
 return the SmpMod value included in the SV ASDU More...
 
uint16_t SVSubscriber_ASDU_getSmpRate (SVSubscriber_ASDU self)
 return the SmpRate value included in the SV ASDU More...
 
bool SVSubscriber_ASDU_hasDatSet (SVSubscriber_ASDU self)
 Check if DatSet value is included in the SV ASDU. More...
 
bool SVSubscriber_ASDU_hasRefrTm (SVSubscriber_ASDU self)
 Check if RefrTm value is included in the SV ASDU. More...
 
bool SVSubscriber_ASDU_hasSmpMod (SVSubscriber_ASDU self)
 Check if SmpMod value is included in the SV ASDU. More...
 
bool SVSubscriber_ASDU_hasSmpRate (SVSubscriber_ASDU self)
 Check if SmpRate value is included in the SV ASDU. More...
 
uint64_t SVSubscriber_ASDU_getRefrTmAsMs (SVSubscriber_ASDU self)
 Get the RefrTim value included in SV ASDU as ms timestamp. More...
 
int8_t SVSubscriber_ASDU_getINT8 (SVSubscriber_ASDU self, int index)
 Get an INT8 data value in the data part of the ASDU. More...
 
int16_t SVSubscriber_ASDU_getINT16 (SVSubscriber_ASDU self, int index)
 Get an INT16 data value in the data part of the ASDU. More...
 
int32_t SVSubscriber_ASDU_getINT32 (SVSubscriber_ASDU self, int index)
 Get an INT32 data value in the data part of the ASDU. More...
 
int64_t SVSubscriber_ASDU_getINT64 (SVSubscriber_ASDU self, int index)
 Get an INT64 data value in the data part of the ASDU. More...
 
uint8_t SVSubscriber_ASDU_getINT8U (SVSubscriber_ASDU self, int index)
 Get an INT8U data value in the data part of the ASDU. More...
 
uint16_t SVSubscriber_ASDU_getINT16U (SVSubscriber_ASDU self, int index)
 Get an INT16U data value in the data part of the ASDU. More...
 
uint32_t SVSubscriber_ASDU_getINT32U (SVSubscriber_ASDU self, int index)
 Get an INT32U data value in the data part of the ASDU. More...
 
uint64_t SVSubscriber_ASDU_getINT64U (SVSubscriber_ASDU self, int index)
 Get an INT64U data value in the data part of the ASDU. More...
 
float SVSubscriber_ASDU_getFLOAT32 (SVSubscriber_ASDU self, int index)
 Get an FLOAT32 data value in the data part of the ASDU. More...
 
double SVSubscriber_ASDU_getFLOAT64 (SVSubscriber_ASDU self, int index)
 Get an FLOAT64 data value in the data part of the ASDU. More...
 
Timestamp SVSubscriber_ASDU_getTimestamp (SVSubscriber_ASDU self, int index)
 Get a timestamp data value in the data part of the ASDU. More...
 
Quality SVSubscriber_ASDU_getQuality (SVSubscriber_ASDU self, int index)
 Get a quality value in the data part of the ASDU. More...
 
int SVSubscriber_ASDU_getDataSize (SVSubscriber_ASDU self)
 Returns the size of the data part of the ASDU. More...
 

Detailed Description

Macro Definition Documentation

#define DEPRECATED

Function Documentation

uint32_t SVSubscriber_ASDU_getConfRev ( SVSubscriber_ASDU  self)

return the ConfRev value included in the SV ASDU

Parameters
selfASDU object instance
int SVSubscriber_ASDU_getDataSize ( SVSubscriber_ASDU  self)

Returns the size of the data part of the ASDU.

Parameters
selfASDU object instance
Returns
size of the ASDU data part in bytes.
const char* SVSubscriber_ASDU_getDatSet ( SVSubscriber_ASDU  self)

return the DatSet value included in the SV ASDU

Parameters
selfASDU object instance
float SVSubscriber_ASDU_getFLOAT32 ( SVSubscriber_ASDU  self,
int  index 
)

Get an FLOAT32 data value in the data part of the ASDU.

Parameters
selfASDU object instance
indexthe index (byte position of the start) of the data in the data part
Returns
SV data
double SVSubscriber_ASDU_getFLOAT64 ( SVSubscriber_ASDU  self,
int  index 
)

Get an FLOAT64 data value in the data part of the ASDU.

Parameters
selfASDU object instance
indexthe index (byte position of the start) of the data in the data part
Returns
SV data
int16_t SVSubscriber_ASDU_getINT16 ( SVSubscriber_ASDU  self,
int  index 
)

Get an INT16 data value in the data part of the ASDU.

Parameters
selfASDU object instance
indexthe index (byte position of the start) of the data in the data part
Returns
SV data
uint16_t SVSubscriber_ASDU_getINT16U ( SVSubscriber_ASDU  self,
int  index 
)

Get an INT16U data value in the data part of the ASDU.

Parameters
selfASDU object instance
indexthe index (byte position of the start) of the data in the data part
Returns
SV data
int32_t SVSubscriber_ASDU_getINT32 ( SVSubscriber_ASDU  self,
int  index 
)

Get an INT32 data value in the data part of the ASDU.

Parameters
selfASDU object instance
indexthe index (byte position of the start) of the data in the data part
Returns
SV data
uint32_t SVSubscriber_ASDU_getINT32U ( SVSubscriber_ASDU  self,
int  index 
)

Get an INT32U data value in the data part of the ASDU.

Parameters
selfASDU object instance
indexthe index (byte position of the start) of the data in the data part
Returns
SV data
int64_t SVSubscriber_ASDU_getINT64 ( SVSubscriber_ASDU  self,
int  index 
)

Get an INT64 data value in the data part of the ASDU.

Parameters
selfASDU object instance
indexthe index (byte position of the start) of the data in the data part
Returns
SV data
uint64_t SVSubscriber_ASDU_getINT64U ( SVSubscriber_ASDU  self,
int  index 
)

Get an INT64U data value in the data part of the ASDU.

Parameters
selfASDU object instance
indexthe index (byte position of the start) of the data in the data part
Returns
SV data
int8_t SVSubscriber_ASDU_getINT8 ( SVSubscriber_ASDU  self,
int  index 
)

Get an INT8 data value in the data part of the ASDU.

Parameters
selfASDU object instance
indexthe index (byte position of the start) of the data in the data part
Returns
SV data
uint8_t SVSubscriber_ASDU_getINT8U ( SVSubscriber_ASDU  self,
int  index 
)

Get an INT8U data value in the data part of the ASDU.

Parameters
selfASDU object instance
indexthe index (byte position of the start) of the data in the data part
Returns
SV data
Quality SVSubscriber_ASDU_getQuality ( SVSubscriber_ASDU  self,
int  index 
)

Get a quality value in the data part of the ASDU.

NOTE: Quality is encoded as BITSTRING (4 byte)

Parameters
selfASDU object instance
indexthe index (byte position of the start) of the data in the data part
Returns
SV data
uint64_t SVSubscriber_ASDU_getRefrTmAsMs ( SVSubscriber_ASDU  self)

Get the RefrTim value included in SV ASDU as ms timestamp.

Parameters
selfASDU object instance
Returns
the time value as ms timestamp or 0 if RefrTm is not present in the SV ASDU
uint16_t SVSubscriber_ASDU_getSmpCnt ( SVSubscriber_ASDU  self)

return the SmpCnt value included in the SV ASDU

The SmpCnt (sample counter) is increased for each ASDU to identify the sample.

Parameters
selfASDU object instance
uint8_t SVSubscriber_ASDU_getSmpMod ( SVSubscriber_ASDU  self)

return the SmpMod value included in the SV ASDU

Parameters
selfASDU object instance
uint16_t SVSubscriber_ASDU_getSmpRate ( SVSubscriber_ASDU  self)

return the SmpRate value included in the SV ASDU

Parameters
selfASDU object instance
const char* SVSubscriber_ASDU_getSvId ( SVSubscriber_ASDU  self)

return the SvID value included in the SV ASDU

Parameters
selfASDU object instance
Timestamp SVSubscriber_ASDU_getTimestamp ( SVSubscriber_ASDU  self,
int  index 
)

Get a timestamp data value in the data part of the ASDU.

Parameters
selfASDU object instance
indexthe index (byte position of the start) of the data in the data part
Returns
SV data
bool SVSubscriber_ASDU_hasDatSet ( SVSubscriber_ASDU  self)

Check if DatSet value is included in the SV ASDU.

Parameters
selfASDU object instance
Returns
true if DatSet value is present, false otherwise
bool SVSubscriber_ASDU_hasRefrTm ( SVSubscriber_ASDU  self)

Check if RefrTm value is included in the SV ASDU.

Parameters
selfASDU object instance
Returns
true if RefrTm value is present, false otherwise
bool SVSubscriber_ASDU_hasSmpMod ( SVSubscriber_ASDU  self)

Check if SmpMod value is included in the SV ASDU.

Parameters
selfASDU object instance
Returns
true if SmpMod value is present, false otherwise
bool SVSubscriber_ASDU_hasSmpRate ( SVSubscriber_ASDU  self)

Check if SmpRate value is included in the SV ASDU.

Parameters
selfASDU object instance
Returns
true if SmpRate value is present, false otherwise
Generated on Tue Apr 3 2018 08:23:24 for libiec61850 by   doxygen 1.8.11