F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
CFDP::Checksum Class Reference

Class representing a CFDP checksum. More...

#include <CFDP/Checksum/Checksum.hpp>

Public Member Functions

 Checksum ()
 Construct a fresh Checksum object. More...
 
 Checksum (const U32 value)
 Construct a Checksum object and initialize it with a value. More...
 
 Checksum (const Checksum &original)
 Copy a Checksum object. More...
 
 ~Checksum ()
 Destroy a Checksum object. More...
 
Checksumoperator= (const Checksum &checksum)
 Assign checksum to this. More...
 
bool operator== (const Checksum &checksum) const
 Compare checksum and this for equality. More...
 
bool operator!= (const Checksum &checksum) const
 Compare checksum and this for inequality. More...
 
void update (const U8 *const data, const U32 offset, const U32 length)
 Update the checksum value by accumulating the words in the data. More...
 
U32 getValue () const
 Get the checksum value. More...
 

Detailed Description

Class representing a CFDP checksum.

Definition at line 23 of file Checksum.hpp.

Constructor & Destructor Documentation

◆ Checksum() [1/3]

CFDP::Checksum::Checksum ( )

Construct a fresh Checksum object.

Definition at line 22 of file Checksum.cpp.

◆ Checksum() [2/3]

CFDP::Checksum::Checksum ( const U32  value)

Construct a Checksum object and initialize it with a value.

Definition at line 28 of file Checksum.cpp.

◆ Checksum() [3/3]

CFDP::Checksum::Checksum ( const Checksum original)

Copy a Checksum object.

Definition at line 34 of file Checksum.cpp.

◆ ~Checksum()

CFDP::Checksum::~Checksum ( )

Destroy a Checksum object.

Definition at line 40 of file Checksum.cpp.

Member Function Documentation

◆ getValue()

U32 CFDP::Checksum::getValue ( ) const

Get the checksum value.

Definition at line 65 of file Checksum.cpp.

◆ operator!=()

bool CFDP::Checksum::operator!= ( const Checksum checksum) const

Compare checksum and this for inequality.

Definition at line 59 of file Checksum.cpp.

◆ operator=()

Checksum & CFDP::Checksum::operator= ( const Checksum checksum)

Assign checksum to this.

Definition at line 46 of file Checksum.cpp.

◆ operator==()

bool CFDP::Checksum::operator== ( const Checksum checksum) const

Compare checksum and this for equality.

Definition at line 53 of file Checksum.cpp.

◆ update()

void CFDP::Checksum::update ( const U8 *const  data,
const U32  offset,
const U32  length 
)

Update the checksum value by accumulating the words in the data.

Parameters
dataThe data
offsetThe offset of the start of the data, relative to the start of the file
lengthThe length of the data in bytes

Definition at line 71 of file Checksum.cpp.


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