dnp3 (C++ API) 1.1.0
dnp3::CommandSet Class Reference

Builder type used to construct command requests. More...

#include <dnp3.hpp>

Public Member Functions

 CommandSet (CommandSet &&other) noexcept
 Transfer ownership of the underlying C-type to this instance and invalidate the other instance. More...
 
 CommandSet ()
 Create a new set of commands. More...
 
 ~CommandSet ()
 Destroy a set of commands. More...
 
void add_g12_v1_u8 (uint8_t idx, const Group12Var1 &header)
 Add a CROB with 1-byte prefix index. More...
 
void add_g12_v1_u16 (uint16_t idx, const Group12Var1 &header)
 Add a CROB with 2-byte prefix index. More...
 
void add_g41_v1_u8 (uint8_t idx, int32_t value)
 Add a Analog Output command (signed 32-bit integer) with 1-byte prefix index. More...
 
void add_g41_v1_u16 (uint16_t idx, int32_t value)
 Add a Analog Output command (signed 32-bit integer) with 2-byte prefix index. More...
 
void add_g41_v2_u8 (uint8_t idx, int16_t value)
 Add a Analog Output command (signed 16-bit integer) with 1-byte prefix index. More...
 
void add_g41_v2_u16 (uint16_t idx, int16_t value)
 Add a Analog Output command (signed 16-bit integer) with 2-byte prefix index. More...
 
void add_g41_v3_u8 (uint8_t idx, float value)
 Add a Analog Output command (single-precision float) with 1-byte prefix index. More...
 
void add_g41_v3_u16 (uint16_t idx, float value)
 Add a Analog Output command (single-precision float) with 2-byte prefix index. More...
 
void add_g41_v4_u8 (uint8_t idx, double value)
 Add a Analog Output command (double-precision float) with 1-byte prefix index. More...
 
void add_g41_v4_u16 (uint16_t idx, double value)
 Add a Analog Output command (double-precision float) with 2-byte prefix index. More...
 
void finish_header ()
 Finish any partially completed header. This allows for the construction of two headers with the same type and index. More...
 

Friends

class CppCommandSetFriend
 

Detailed Description

Builder type used to construct command requests.

Constructor & Destructor Documentation

◆ CommandSet() [1/2]

dnp3::CommandSet::CommandSet ( CommandSet &&  other)
inlinenoexcept

Transfer ownership of the underlying C-type to this instance and invalidate the other instance.

Note
the moved class will now throw an exception if any method is called
Parameters
otherClass from which ownership will be transfer to this instance

◆ CommandSet() [2/2]

dnp3::CommandSet::CommandSet ( )

Create a new set of commands.

◆ ~CommandSet()

dnp3::CommandSet::~CommandSet ( )

Destroy a set of commands.

Member Function Documentation

◆ add_g12_v1_u16()

void dnp3::CommandSet::add_g12_v1_u16 ( uint16_t  idx,
const Group12Var1 header 
)

Add a CROB with 2-byte prefix index.

Parameters
idxIndex of the point to send the command to
headerCROB data

◆ add_g12_v1_u8()

void dnp3::CommandSet::add_g12_v1_u8 ( uint8_t  idx,
const Group12Var1 header 
)

Add a CROB with 1-byte prefix index.

Parameters
idxIndex of the point to send the command to
headerCROB data

◆ add_g41_v1_u16()

void dnp3::CommandSet::add_g41_v1_u16 ( uint16_t  idx,
int32_t  value 
)

Add a Analog Output command (signed 32-bit integer) with 2-byte prefix index.

Parameters
idxIndex of the point to send the command to
valueValue to set the analog output to

◆ add_g41_v1_u8()

void dnp3::CommandSet::add_g41_v1_u8 ( uint8_t  idx,
int32_t  value 
)

Add a Analog Output command (signed 32-bit integer) with 1-byte prefix index.

Parameters
idxIndex of the point to send the command to
valueValue to set the analog output to

◆ add_g41_v2_u16()

void dnp3::CommandSet::add_g41_v2_u16 ( uint16_t  idx,
int16_t  value 
)

Add a Analog Output command (signed 16-bit integer) with 2-byte prefix index.

Parameters
idxIndex of the point to send the command to
valueValue to set the analog output to

◆ add_g41_v2_u8()

void dnp3::CommandSet::add_g41_v2_u8 ( uint8_t  idx,
int16_t  value 
)

Add a Analog Output command (signed 16-bit integer) with 1-byte prefix index.

Parameters
idxIndex of the point to send the command to
valueValue to set the analog output to

◆ add_g41_v3_u16()

void dnp3::CommandSet::add_g41_v3_u16 ( uint16_t  idx,
float  value 
)

Add a Analog Output command (single-precision float) with 2-byte prefix index.

Parameters
idxIndex of the point to send the command to
valueValue to set the analog output to

◆ add_g41_v3_u8()

void dnp3::CommandSet::add_g41_v3_u8 ( uint8_t  idx,
float  value 
)

Add a Analog Output command (single-precision float) with 1-byte prefix index.

Parameters
idxIndex of the point to send the command to
valueValue to set the analog output to

◆ add_g41_v4_u16()

void dnp3::CommandSet::add_g41_v4_u16 ( uint16_t  idx,
double  value 
)

Add a Analog Output command (double-precision float) with 2-byte prefix index.

Parameters
idxIndex of the point to send the command to
valueValue to set the analog output to

◆ add_g41_v4_u8()

void dnp3::CommandSet::add_g41_v4_u8 ( uint8_t  idx,
double  value 
)

Add a Analog Output command (double-precision float) with 1-byte prefix index.

Parameters
idxIndex of the point to send the command to
valueValue to set the analog output to

◆ finish_header()

void dnp3::CommandSet::finish_header ( )

Finish any partially completed header. This allows for the construction of two headers with the same type and index.


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