opendnp3  3.1.0
Reference implementation of DNP3 (IEEE-1815)
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
opendnp3::Header Class Reference

Class used to specify a header type. More...

#include <opendnp3/master/HeaderTypes.h>

Public Member Functions

 Header ()=default
 
bool WriteTo (HeaderWriter &writer) const
 

Static Public Member Functions

static Header AllObjects (uint8_t group, uint8_t variation)
 Create an all objects (0x06) header. More...
 
static Header Count16 (uint8_t group, uint8_t variation, uint16_t count)
 Create a 16-bit count header (0x08) More...
 
static Header Count8 (uint8_t group, uint8_t variation, uint8_t count)
 Create a 8-bit count header (0x07) More...
 
static Header From (PointClass pc)
 Create an all objects (0x06) header. More...
 
static Header Range16 (uint8_t group, uint8_t variation, uint16_t start, uint16_t stop)
 Create a 16-bit start stop header (0x01) More...
 
static Header Range8 (uint8_t group, uint8_t variation, uint8_t start, uint8_t stop)
 Create a 8-bit start stop header (0x00) More...
 

Private Member Functions

 Header (uint8_t group, uint8_t var)
 
 Header (uint8_t group, uint8_t var, uint16_t count)
 
 Header (uint8_t group, uint8_t var, uint16_t start, uint16_t stop)
 
 Header (uint8_t group, uint8_t var, uint8_t count)
 
 Header (uint8_t group, uint8_t var, uint8_t start, uint8_t stop)
 

Private Attributes

GroupVariationID id
 
HeaderType type = HeaderType::AllObjects
 
HeaderUnion value
 

Detailed Description

Class used to specify a header type.

Definition at line 77 of file HeaderTypes.h.

Constructor & Destructor Documentation

◆ Header() [1/6]

opendnp3::Header::Header ( )
default

◆ Header() [2/6]

opendnp3::Header::Header ( uint8_t  group,
uint8_t  var 
)
private

◆ Header() [3/6]

opendnp3::Header::Header ( uint8_t  group,
uint8_t  var,
uint8_t  start,
uint8_t  stop 
)
private

◆ Header() [4/6]

opendnp3::Header::Header ( uint8_t  group,
uint8_t  var,
uint16_t  start,
uint16_t  stop 
)
private

◆ Header() [5/6]

opendnp3::Header::Header ( uint8_t  group,
uint8_t  var,
uint8_t  count 
)
private

◆ Header() [6/6]

opendnp3::Header::Header ( uint8_t  group,
uint8_t  var,
uint16_t  count 
)
private

Member Function Documentation

◆ AllObjects()

static Header opendnp3::Header::AllObjects ( uint8_t  group,
uint8_t  variation 
)
static

Create an all objects (0x06) header.

◆ Count16()

static Header opendnp3::Header::Count16 ( uint8_t  group,
uint8_t  variation,
uint16_t  count 
)
static

Create a 16-bit count header (0x08)

◆ Count8()

static Header opendnp3::Header::Count8 ( uint8_t  group,
uint8_t  variation,
uint8_t  count 
)
static

Create a 8-bit count header (0x07)

◆ From()

static Header opendnp3::Header::From ( PointClass  pc)
static

Create an all objects (0x06) header.

◆ Range16()

static Header opendnp3::Header::Range16 ( uint8_t  group,
uint8_t  variation,
uint16_t  start,
uint16_t  stop 
)
static

Create a 16-bit start stop header (0x01)

◆ Range8()

static Header opendnp3::Header::Range8 ( uint8_t  group,
uint8_t  variation,
uint8_t  start,
uint8_t  stop 
)
static

Create a 8-bit start stop header (0x00)

◆ WriteTo()

bool opendnp3::Header::WriteTo ( HeaderWriter &  writer) const

Member Data Documentation

◆ id

GroupVariationID opendnp3::Header::id
private

Definition at line 115 of file HeaderTypes.h.

◆ type

HeaderType opendnp3::Header::type = HeaderType::AllObjects
private

Definition at line 116 of file HeaderTypes.h.

◆ value

HeaderUnion opendnp3::Header::value
private

Definition at line 117 of file HeaderTypes.h.

The documentation for this class was generated from the following file: