dnp3::WriteDeadBandRequest Class Reference

Define a custom request to WRITE analog input dead-bands. More...

#include <dnp3.hpp>

Public Member Functions
	WriteDeadBandRequest (WriteDeadBandRequest &&other) noexcept
	Transfer ownership of the underlying C-type to this instance and invalidate the other instance. More...
	WriteDeadBandRequest ()
	A builder class to create one or more headers of analog input dead-bands. More...
	~WriteDeadBandRequest ()
	Destroy a request created with WriteDeadBandRequest::WriteDeadBandRequest() More...
void	add_g34v1_u8 (uint8_t index, uint16_t dead_band)
	Add a g34v1 (unsigned 16-bit) dead-band with 8-bit indexing to the request. More...
void	add_g34v2_u8 (uint8_t index, uint32_t dead_band)
	Add a g34v2 (unsigned 32-bit) dead-band with 8-bit indexing to the request. More...
void	add_g34v3_u8 (uint8_t index, float dead_band)
	Add a g34v3 (single-precision floating point) dead-band with 8-bit indexing to the request. More...
void	add_g34v1_u16 (uint16_t index, uint16_t dead_band)
	Add a g34v1 (unsigned 16-bit) dead-band with 16-bit indexing to the request. More...
void	add_g34v2_u16 (uint16_t index, uint32_t dead_band)
	Add a g34v2 (unsigned 32-bit) dead-band with 16-bit indexing to the request. More...
void	add_g34v3_u16 (uint16_t index, float dead_band)
	Add a g34v3 (single-precision floating point) dead-band with 16-bit indexing to the request. More...
void	finish_header ()
	If a header is currently being written, then this will complete the header so that no new objects may be added to it. More...

Friends
class	CppWriteDeadBandRequestFriend

Detailed Description

Define a custom request to WRITE analog input dead-bands.

Constructor & Destructor Documentation

WriteDeadBandRequest() [1/2]

dnp3::WriteDeadBandRequest::WriteDeadBandRequest ( WriteDeadBandRequest &&  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

other

Class from which ownership will be transfer to this instance

WriteDeadBandRequest() [2/2]

dnp3::WriteDeadBandRequest::WriteDeadBandRequest

(

)

A builder class to create one or more headers of analog input dead-bands.

~WriteDeadBandRequest()

dnp3::WriteDeadBandRequest::~WriteDeadBandRequest

(

)

Destroy a request created with WriteDeadBandRequest::WriteDeadBandRequest()

Member Function Documentation

add_g34v1_u16()

void dnp3::WriteDeadBandRequest::add_g34v1_u16	(	uint16_t	index,
		uint16_t	dead_band
	)

Add a g34v1 (unsigned 16-bit) dead-band with 16-bit indexing to the request.

If this variation and index are the same as the current header, then it will be added to it. Otherwise, this call we create a new header of this type.d

Parameters

index	Index of the analog input to which the dead-band applies
dead_band	Value of the dead-band

add_g34v1_u8()

void dnp3::WriteDeadBandRequest::add_g34v1_u8	(	uint8_t	index,
		uint16_t	dead_band
	)

Add a g34v1 (unsigned 16-bit) dead-band with 8-bit indexing to the request.

If this variation and index are the same as the current header, then it will be added to it. Otherwise, this call we create a new header of this type.d

Parameters

index	Index of the analog input to which the dead-band applies
dead_band	Value of the dead-band

add_g34v2_u16()

void dnp3::WriteDeadBandRequest::add_g34v2_u16	(	uint16_t	index,
		uint32_t	dead_band
	)

Add a g34v2 (unsigned 32-bit) dead-band with 16-bit indexing to the request.

If this variation and index are the same as the current header, then it will be added to it. Otherwise, this call we create a new header of this type.d

Parameters

index	Index of the analog input to which the dead-band applies
dead_band	Value of the dead-band

add_g34v2_u8()

void dnp3::WriteDeadBandRequest::add_g34v2_u8	(	uint8_t	index,
		uint32_t	dead_band
	)

Add a g34v2 (unsigned 32-bit) dead-band with 8-bit indexing to the request.

If this variation and index are the same as the current header, then it will be added to it. Otherwise, this call we create a new header of this type.d

Parameters

index	Index of the analog input to which the dead-band applies
dead_band	Value of the dead-band

add_g34v3_u16()

void dnp3::WriteDeadBandRequest::add_g34v3_u16	(	uint16_t	index,
		float	dead_band
	)

Add a g34v3 (single-precision floating point) dead-band with 16-bit indexing to the request.

If this variation and index are the same as the current header, then it will be added to it. Otherwise, this call we create a new header of this type.d

Parameters

index	Index of the analog input to which the dead-band applies
dead_band	Value of the dead-band

add_g34v3_u8()

void dnp3::WriteDeadBandRequest::add_g34v3_u8	(	uint8_t	index,
		float	dead_band
	)

Add a g34v3 (single-precision floating point) dead-band with 8-bit indexing to the request.

If this variation and index are the same as the current header, then it will be added to it. Otherwise, this call we create a new header of this type.d

Parameters

index	Index of the analog input to which the dead-band applies
dead_band	Value of the dead-band

finish_header()

void dnp3::WriteDeadBandRequest::finish_header

(

)

If a header is currently being written, then this will complete the header so that no new objects may be added to it.

This happens automatically if you change the type or index when adding dead-band values. This method allows you to fragment the same type across multiple object headers.

---

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

• dnp3.hpp