ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Common::CheckSum Class Referenceabstract

#include <CheckSum.hh>

Inheritance diagram for FrameCPP::Common::CheckSum:
Inheritance graph
[legend]

Public Types

enum  kind_type {
  UNSET = -1 , NONE = 0 , CRC = 1 , UNSET = -1 ,
  NONE = 0 , CRC = 1
}
enum  kind_type {
  UNSET = -1 , NONE = 0 , CRC = 1 , UNSET = -1 ,
  NONE = 0 , CRC = 1
}
typedef INT_8U size_type
typedef INT_4U value_type
typedef INT_8U size_type
typedef INT_4U value_type

Public Member Functions

 CheckSum (const kind_type Type)
virtual ~CheckSum ()
kind_type GetType () const
virtual void Reset ()
virtual void calc (const void *Buffer, size_type NBytes)=0
value_type value ()
 Things to be do to.
virtual CheckSum * Clone () const =0
 CheckSum (const kind_type Type)
virtual ~CheckSum ()
kind_type GetType () const
virtual void Reset ()
virtual void calc (const void *Buffer, size_type NBytes)=0
value_type value ()
 Things to be do to.
virtual CheckSum * Clone () const =0

Static Public Member Functions

static CheckSum * Create (kind_type Type)
static CheckSum * Create (kind_type Type, value_type Value)
static std::string FormatError (value_type ExpectedValue, value_type CalculatedValue)
static CheckSum * Create (kind_type Type)
static CheckSum * Create (kind_type Type, value_type Value)
static std::string FormatError (value_type ExpectedValue, value_type CalculatedValue)

Protected Member Functions

 CheckSum (const CheckSum &Source)
virtual void finish ()=0
 CheckSum (const CheckSum &Source)
virtual void finish ()=0

Protected Attributes

value_type m_value

Private Member Functions

 CheckSum ()
 CheckSum ()

Private Attributes

kind_type m_type = UNSET

Member Typedef Documentation

◆ size_type [1/2]

typedef INT_8U FrameCPP::Common::CheckSum::size_type

◆ size_type [2/2]

typedef INT_8U FrameCPP::Common::CheckSum::size_type

◆ value_type [1/2]

typedef INT_4U FrameCPP::Common::CheckSum::value_type

◆ value_type [2/2]

typedef INT_4U FrameCPP::Common::CheckSum::value_type

Member Enumeration Documentation

◆ kind_type [1/2]

enum FrameCPP::Common::CheckSum::kind_type
Enumerator
UNSET 
NONE 
CRC 
UNSET 
NONE 
CRC 

◆ kind_type [2/2]

enum FrameCPP::Common::CheckSum::kind_type
Enumerator
UNSET 
NONE 
CRC 
UNSET 
NONE 
CRC 

Constructor & Destructor Documentation

◆ CheckSum() [1/6]

FrameCPP::Common::CheckSum::CheckSum ( const kind_type Type)

◆ ~CheckSum() [1/2]

FrameCPP::Common::CheckSum::~CheckSum ( )
virtual

◆ CheckSum() [2/6]

FrameCPP::Common::CheckSum::CheckSum ( const CheckSum & Source)
protected

◆ CheckSum() [3/6]

FrameCPP::Common::CheckSum::CheckSum ( )
private

◆ CheckSum() [4/6]

FrameCPP::Common::CheckSum::CheckSum ( const kind_type Type)

◆ ~CheckSum() [2/2]

virtual FrameCPP::Common::CheckSum::~CheckSum ( )
virtual

◆ CheckSum() [5/6]

FrameCPP::Common::CheckSum::CheckSum ( const CheckSum & Source)
protected

◆ CheckSum() [6/6]

FrameCPP::Common::CheckSum::CheckSum ( )
private

Member Function Documentation

◆ calc() [1/2]

virtual void FrameCPP::Common::CheckSum::calc ( const void * Buffer,
size_type NBytes )
pure virtual

Implemented in CheckSumCRC, CheckSumCRC, FrameCPP::Common::CheckSumCRC, and FrameCPP::Common::CheckSumCRC.

◆ calc() [2/2]

virtual void FrameCPP::Common::CheckSum::calc ( const void * Buffer,
size_type NBytes )
pure virtual

Implemented in CheckSumCRC, CheckSumCRC, FrameCPP::Common::CheckSumCRC, and FrameCPP::Common::CheckSumCRC.

◆ Clone() [1/2]

virtual CheckSum * FrameCPP::Common::CheckSum::Clone ( ) const
pure virtual

Implemented in CheckSumCRC, CheckSumCRC, FrameCPP::Common::CheckSumCRC, and FrameCPP::Common::CheckSumCRC.

◆ Clone() [2/2]

virtual CheckSum * FrameCPP::Common::CheckSum::Clone ( ) const
pure virtual

Implemented in CheckSumCRC, CheckSumCRC, FrameCPP::Common::CheckSumCRC, and FrameCPP::Common::CheckSumCRC.

◆ Create() [1/4]

CheckSum * FrameCPP::Common::CheckSum::Create ( kind_type Type)
static

◆ Create() [2/4]

CheckSum * FrameCPP::Common::CheckSum::Create ( kind_type Type)
static

◆ Create() [3/4]

CheckSum * FrameCPP::Common::CheckSum::Create ( kind_type Type,
value_type Value )
static

◆ Create() [4/4]

CheckSum * FrameCPP::Common::CheckSum::Create ( kind_type Type,
value_type Value )
static

◆ finish() [1/2]

virtual void FrameCPP::Common::CheckSum::finish ( )
protectedpure virtual

Implemented in CheckSumCRC, CheckSumCRC, FrameCPP::Common::CheckSumCRC, and FrameCPP::Common::CheckSumCRC.

◆ finish() [2/2]

virtual void FrameCPP::Common::CheckSum::finish ( )
protectedpure virtual

Implemented in CheckSumCRC, CheckSumCRC, FrameCPP::Common::CheckSumCRC, and FrameCPP::Common::CheckSumCRC.

◆ FormatError() [1/2]

std::string FrameCPP::Common::CheckSum::FormatError ( value_type ExpectedValue,
value_type CalculatedValue )
static

◆ FormatError() [2/2]

std::string FrameCPP::Common::CheckSum::FormatError ( value_type ExpectedValue,
value_type CalculatedValue )
static

◆ GetType() [1/2]

CheckSum::kind_type FrameCPP::Common::CheckSum::GetType ( ) const
inline

◆ GetType() [2/2]

kind_type FrameCPP::Common::CheckSum::GetType ( ) const

◆ Reset() [1/2]

void FrameCPP::Common::CheckSum::Reset ( )
virtual

Reimplemented in CheckSumCRC, CheckSumCRC, FrameCPP::Common::CheckSumCRC, and FrameCPP::Common::CheckSumCRC.

◆ Reset() [2/2]

virtual void FrameCPP::Common::CheckSum::Reset ( )
virtual

Reimplemented in CheckSumCRC, CheckSumCRC, FrameCPP::Common::CheckSumCRC, and FrameCPP::Common::CheckSumCRC.

◆ value() [1/2]

CheckSum::value_type FrameCPP::Common::CheckSum::value ( )
inline

Things to be do to.

Things to do to complete the calculation

◆ value() [2/2]

value_type FrameCPP::Common::CheckSum::value ( )

Things to be do to.

Things to do to complete the calculation

Member Data Documentation

◆ m_type

kind_type FrameCPP::Common::CheckSum::m_type = UNSET
private

◆ m_value

value_type FrameCPP::Common::CheckSum::m_value
protected
The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Common/CheckSum.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/CheckSum.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/CheckSum.cc