Alchemy  1.0
A framework to robustly process network messages and structured data
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Types | List of all members
Hg::BitField< OwnerT, TagT, OffsetT, CountT, T > Struct Template Reference

Represents a single entry for a bit field type definition. More...

#include <bit_field.h>

Public Types

enum  
 The BitField Mask can be described with this formula: More...
 

Detailed Description

template<class OwnerT, class TagT, size_t OffsetT, size_t CountT, class T = uint8_t>
struct Hg::BitField< OwnerT, TagT, OffsetT, CountT, T >

Represents a single entry for a bit field type definition.

In order for BitFields to be packed into a single byte, the BitFields must be grouped in a BitSet definition. This type must be contained within another class that supports a function called value() that returns a value that is convertable to type T.

Note
The total number of requested bits must fit within the specified data-field type. The default is a 8-bit byte.

Definition at line 34 of file bit_field.h.

Member Enumeration Documentation

template<class OwnerT , class TagT , size_t OffsetT, size_t CountT, class T = uint8_t>
anonymous enum

The BitField Mask can be described with this formula:

Mask = (2 ^ (number of bits))-1 << shifted to the left by offset bits.

Definition at line 51 of file bit_field.h.


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