opendnp3::CommandPointResult Class Reference

Represents the result of a command operation on a particular point. More...

#include <opendnp3/master/CommandPointResult.h>

Public Member Functions
	CommandPointResult (uint32_t headerIndex_, uint16_t index_, CommandPointState state_, CommandStatus status_)
	Fully construct based on all members. More...
bool	Equals (const CommandPointResult &other) const
	Check the result for equality against another value. More...

Public Attributes
uint32_t	headerIndex
	The index of the header when request was made (0-based) More...
uint16_t	index
	The index of the command that was requested. More...
CommandPointState	state
	The final state of the command operation on this point. More...
CommandStatus	status
	The response value. This is only valid if state == SUCCESS or state == SELECT_FAIL. More...

Detailed Description

Represents the result of a command operation on a particular point.

Definition at line 31 of file CommandPointResult.h.

Constructor & Destructor Documentation

CommandPointResult()

opendnp3::CommandPointResult::CommandPointResult ( uint32_t  headerIndex_, uint16_t  index_, CommandPointState  state_, CommandStatus  status_  )

inline

Fully construct based on all members.

Definition at line 36 of file CommandPointResult.h.

Member Function Documentation

Equals()

bool opendnp3::CommandPointResult::Equals ( const CommandPointResult &  other ) const

inline

Check the result for equality against another value.

Definition at line 42 of file CommandPointResult.h.

References headerIndex, index, state, and status.

Member Data Documentation

headerIndex

uint32_t opendnp3::CommandPointResult::headerIndex

The index of the header when request was made (0-based)

Definition at line 49 of file CommandPointResult.h.

Referenced by Equals().

index

uint16_t opendnp3::CommandPointResult::index

The index of the command that was requested.

Definition at line 52 of file CommandPointResult.h.

Referenced by Equals().

state

CommandPointState opendnp3::CommandPointResult::state

The final state of the command operation on this point.

Definition at line 55 of file CommandPointResult.h.

Referenced by Equals().

status

CommandStatus opendnp3::CommandPointResult::status

The response value. This is only valid if state == SUCCESS or state == SELECT_FAIL.

Definition at line 58 of file CommandPointResult.h.

Referenced by Equals().

---

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

• opendnp3/master/CommandPointResult.h