Stefan Scholz / ETL
Embed: (wiki syntax)

« Back to documentation index

frame_check_sequence< TPolicy > Class Template Reference

frame_check_sequence< TPolicy > Class Template Reference
[Frame check sequence calculation]

Calculates a frame check sequence according to the specified policy. More...

#include <frame_check_sequence.h>

Public Member Functions

 frame_check_sequence ()
 Default constructor.
template<typename TIterator >
 frame_check_sequence (TIterator begin, const TIterator end)
 Constructor from range.
void reset ()
 Resets the FCS to the initial state.
template<typename TIterator >
void add (TIterator begin, const TIterator end)
 Adds a range.
void add (uint8_t value_)
value_type value ()
 Gets the FCS value.
 operator value_type ()
 Conversion operator to value_type.

Detailed Description

template<typename TPolicy>
class etl::frame_check_sequence< TPolicy >

Calculates a frame check sequence according to the specified policy.

Template Parameters:
TPolicyThe type used to enact the policy.

Definition at line 50 of file frame_check_sequence.h.


Constructor & Destructor Documentation

Default constructor.

Definition at line 62 of file frame_check_sequence.h.

frame_check_sequence ( TIterator  begin,
const TIterator  end 
)

Constructor from range.

Parameters:
beginStart of the range.
endEnd of the range.

Definition at line 73 of file frame_check_sequence.h.


Member Function Documentation

void add ( TIterator  begin,
const TIterator  end 
)

Adds a range.

Parameters:
begin
end

Definition at line 95 of file frame_check_sequence.h.

void add ( uint8_t  value_ )
Parameters:
valueThe uint8_t to add to the FCS.

Definition at line 108 of file frame_check_sequence.h.

operator value_type (  )

Conversion operator to value_type.

Definition at line 124 of file frame_check_sequence.h.

void reset (  )

Resets the FCS to the initial state.

Definition at line 84 of file frame_check_sequence.h.

value_type value (  )

Gets the FCS value.

Definition at line 116 of file frame_check_sequence.h.