Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

eformat::helper::Status Class Reference

#include <Status.h>

List of all members.

Public Member Functions

uint32_t code (void) const
uint32_t code (void) const
eformat::GenericStatus generic (void) const
eformat::GenericStatus generic (void) const
uint16_t specific (void) const
uint16_t specific (void) const
 Status (uint32_t v)
 Status (eformat::GenericStatus gen, uint16_t spec)
 Status (uint32_t v)
 Status (eformat::GenericStatus gen, uint16_t spec)

Private Attributes

eformat::GenericStatus m_gen
 The generic part.
uint16_t m_spec
 The specific part.

Detailed Description

Defines converters between version numbers and its components

Constructor & Destructor Documentation

eformat::helper::Status::Status (  eformat::GenericStatus  gen,
uint16_t  spec
)  [inline]
 

Constructor. Takes the components to form a status

Parameters:
gen The generic component
spec The specific component 
00061         : m_gen(gen), m_spec(spec) {}

eformat::helper::Status::Status (  uint32_t  v  ) 
 

Constructor. Takes the status to understand the components from.

Parameters:
s The status number, fully built.
Warning:
This status value has to conform to the current version of the library or unpredictable results might occur. 
00016   : m_gen(static_cast<eformat::GenericStatus>(v&0xffff)),
00017     m_spec((v>>16)&0xffff)
00018 {
00019 }

eformat::helper::Status::Status (  eformat::GenericStatus  gen,
uint16_t  spec
)  [inline]
 

Constructor. Takes the components to form a status

Parameters:
gen The generic component
spec The specific component 
00061         : m_gen(gen), m_spec(spec) {}

eformat::helper::Status::Status (  uint32_t  v  ) 
 

Constructor. Takes the status to understand the components from.

Parameters:
s The status number, fully built.
Warning:
This status value has to conform to the current version of the library or unpredictable results might occur.

Member Function Documentation

uint32_t eformat::helper::Status::code (  void   )  const
 

Gets the full 32-bit number made by assembling the 2 numbers above.

uint32_t eformat::helper::Status::code (  void   )  const
 

Gets the full 32-bit number made by assembling the 2 numbers above. 

00022 {
00023   uint32_t retval = m_spec;
00024   retval <<= 16;
00025   retval |= m_gen;
00026   return retval;
00027 }

eformat::GenericStatus eformat::helper::Status::generic (  void   )  const [inline]
 

Extracts the generic part of this status word 

00075 { return m_gen; }

eformat::GenericStatus eformat::helper::Status::generic (  void   )  const [inline]
 

Extracts the generic part of this status word 

00075 { return m_gen; }

uint16_t eformat::helper::Status::specific (  void   )  const [inline]
 

Extracts the specific part of this status word 

00080 { return m_spec; }

uint16_t eformat::helper::Status::specific (  void   )  const [inline]
 

Extracts the specific part of this status word 

00080 { return m_spec; }

Member Data Documentation

eformat::GenericStatus eformat::helper::Status::m_gen [private]
 

The generic part.

uint16_t eformat::helper::Status::m_spec [private]
 

The specific part.

The documentation for this class was generated from the following files:
Generated on Wed Feb 2 19:18:45 2011 for BOSS6.5.5 by  doxygen 1.3.9.1