DUNE: Uniform Navigational Environment  2.6.0-rc4
DUNE::Utils Namespace Reference

Detailed Description

General purpose types and routines.

Namespaces

 Codecs
 

Classes

class  BitBuffer
 
class  ByteBuffer
 
class  ByteCopy
 
class  CircularBuffer
 
class  IOError
 
class  ZipFileError
 
class  ParseError
 
struct  NMEASentence
 
class  NMEAParser
 
class  OptionParser
 
class  RawFifo
 
class  StateMachine
 
class  String
 
class  TupleList
 
class  XML
 

Enumerations

enum  NMEACommands {
  GGA, RMC, GSV, GLL,
  ZDA, TXT, VTG
}
 

Functions

std::ostream & operator<< (std::ostream &os, BitBuffer &buffer)
 
std::ostream & operator<< (std::ostream &os, ByteBuffer &buffer)
 
void reverseCopy2b (char *dest, const char *src)
 
void reverseCopy4b (char *dest, const char *src)
 
void reverseCopy8b (char *dest, const char *src)
 
uint16_t reverseCopy (char *dest, const uint16_t &src)
 
uint16_t reverseCopy (char *dest, const int16_t &src)
 
uint16_t reverseCopy (uint16_t &dest, const char *src)
 
uint16_t reverseCopy (int16_t &dest, const char *src)
 
uint16_t reverseCopy (char *dest, const int32_t &src)
 
uint16_t reverseCopy (char *dest, const uint32_t &src)
 
uint16_t reverseCopy (int32_t &dest, const char *src)
 
uint16_t reverseCopy (uint32_t &dest, const char *src)
 
uint16_t reverseCopy (char *dest, const int64_t &src)
 
uint16_t reverseCopy (char *dest, const uint64_t &src)
 
uint16_t reverseCopy (int64_t &dest, const char *src)
 
uint16_t reverseCopy (uint64_t &dest, const char *src)
 
uint16_t reverseCopy (char *dest, const fp32_t &src)
 
uint16_t reverseCopy (float &dest, const char *src)
 
uint16_t reverseCopy (char *dest, const fp64_t &src)
 
uint16_t reverseCopy (double &dest, const char *src)
 
uint16_t reverseCopy (char *dest, const char *src, uint16_t n)
 
template<typename Type >
uint16_t copy (char *dest, const Type &src, uint16_t size=sizeof(Type))
 
uint16_t copy (uint32_t &dest, const char *src)
 
uint16_t copy (char *dest, const char *src, uint16_t size)
 
uint16_t copy (char *dest, const uint8_t *src, uint16_t size)
 
std::ostream & operator<< (std::ostream &os, const TupleList &tl)
 
std::string & operator<< (std::string &os, const TupleList &tl)
 

Variables

struct DUNE_DLL_SYM NMEASentence
 
class DUNE_DLL_SYM NMEAParser
 
class DUNE_DLL_SYM OptionParser
 
class DUNE_DLL_SYM RawFifo
 
class DUNE_DLL_SYM String
 
class DUNE_DLL_SYM TupleList
 

Enumeration Type Documentation

Enumerator
GGA 
RMC 
GSV 
GLL 
ZDA 
TXT 
VTG 

Function Documentation

template<typename Type >
uint16_t DUNE::Utils::copy ( char *  dest,
const Type &  src,
uint16_t  size = sizeof(Type) 
)
inline
uint16_t DUNE::Utils::copy ( uint32_t &  dest,
const char *  src 
)
inline
uint16_t DUNE::Utils::copy ( char *  dest,
const char *  src,
uint16_t  size 
)
inline
uint16_t DUNE::Utils::copy ( char *  dest,
const uint8_t *  src,
uint16_t  size 
)
inline
std::ostream& DUNE::Utils::operator<< ( std::ostream &  os,
const TupleList &  tl 
)
std::string& DUNE::Utils::operator<< ( std::string &  os,
const TupleList &  tl 
)
std::ostream& DUNE::Utils::operator<< ( std::ostream &  os,
ByteBuffer &  buffer 
)
inline
std::ostream& DUNE::Utils::operator<< ( std::ostream &  os,
BitBuffer &  buffer 
)
inline
uint16_t DUNE::Utils::reverseCopy ( char *  dest,
const uint16_t &  src 
)
inline

Copy a 16 bit unsigned integer to a memory area while reversing the order of the bytes.

Parameters
destdestination memory area.
srcsource 16 bit unsigned integer.
Returns
number of copied bytes.

References reverseCopy2b().

Referenced by DUNE::IMC::reverseDeserialize(), DUNE::IMC::InlineMessage< DUNE::IMC::ControlCommand >::reverseDeserialize(), and DUNE::IMC::MessageList< DUNE::IMC::PathPoint >::reverseDeserialize().

uint16_t DUNE::Utils::reverseCopy ( char *  dest,
const int16_t &  src 
)
inline

Copy a 16 bit signed integer to a memory area while reversing the order of the bytes.

Parameters
destdestination memory area.
srcsource 16 bit unsigned integer.
Returns
number of copied bytes.

References reverseCopy2b().

uint16_t DUNE::Utils::reverseCopy ( uint16_t &  dest,
const char *  src 
)
inline

References reverseCopy2b().

uint16_t DUNE::Utils::reverseCopy ( int16_t &  dest,
const char *  src 
)
inline

References reverseCopy2b().

uint16_t DUNE::Utils::reverseCopy ( char *  dest,
const int32_t &  src 
)
inline

Copy a 32 bit signed integer to a memory area while reversing the order of the bytes.

Parameters
destdestination memory area.
srcsource 32 bit signed integer.
Returns
number of copied bytes.

References reverseCopy4b().

uint16_t DUNE::Utils::reverseCopy ( char *  dest,
const uint32_t &  src 
)
inline

Copy a 32 bit unsigned integer to a memory area while reversing the order of the bytes.

Parameters
destdestination memory area.
srcsource 32 bit unsigned integer.
Returns
number of copied bytes.

References reverseCopy4b().

uint16_t DUNE::Utils::reverseCopy ( int32_t &  dest,
const char *  src 
)
inline

References reverseCopy4b().

uint16_t DUNE::Utils::reverseCopy ( uint32_t &  dest,
const char *  src 
)
inline

References reverseCopy4b().

uint16_t DUNE::Utils::reverseCopy ( char *  dest,
const int64_t &  src 
)
inline

Copy a 64 bit signed integer to a memory area while reversing the order of the bytes.

Parameters
destdestination memory area.
srcsource 64 bit signed integer.
Returns
number of copied bytes.

References reverseCopy8b().

uint16_t DUNE::Utils::reverseCopy ( char *  dest,
const uint64_t &  src 
)
inline

Copy a 64 bit unsigned integer to a memory area while reversing the order of the bytes.

Parameters
destdestination memory area.
srcsource 64 bit unsigned integer.
Returns
number of copied bytes.

References reverseCopy8b().

uint16_t DUNE::Utils::reverseCopy ( int64_t &  dest,
const char *  src 
)
inline

References reverseCopy8b().

uint16_t DUNE::Utils::reverseCopy ( uint64_t &  dest,
const char *  src 
)
inline

References reverseCopy8b().

uint16_t DUNE::Utils::reverseCopy ( char *  dest,
const fp32_t &  src 
)
inline

Copy a single precision floating point variable to a memory area while reversing the order of the bytes.

Parameters
destdestination memory area.
srcsource single precision floating point variable.
Returns
number of copied bytes.

References reverseCopy4b().

uint16_t DUNE::Utils::reverseCopy ( float &  dest,
const char *  src 
)
inline

References reverseCopy4b().

uint16_t DUNE::Utils::reverseCopy ( char *  dest,
const fp64_t &  src 
)
inline

Copy a double precision floating point variable to a memory area while reversing the order of the bytes.

Parameters
destdestination memory area.
srcsource double precision floating point variable.
Returns
number of copied bytes.

References reverseCopy8b().

uint16_t DUNE::Utils::reverseCopy ( double &  dest,
const char *  src 
)
inline

References reverseCopy8b().

uint16_t DUNE::Utils::reverseCopy ( char *  dest,
const char *  src,
uint16_t  n 
)
inline

Copy the bytes of a memory area while reversing the order of the bytes.

Parameters
destdestination memory area.
srcsource memory area.
namount of bytes to copy.
Returns
number of copied bytes.
void DUNE::Utils::reverseCopy2b ( char *  dest,
const char *  src 
)
inline

Copy two bytes of a memory area while reversing the order of the bytes.

Parameters
destdestination memory area.
srcsource memory area.

Referenced by reverseCopy().

void DUNE::Utils::reverseCopy4b ( char *  dest,
const char *  src 
)
inline

Copy four bytes of a memory area while reversing the order of the bytes.

Parameters
destdestination memory area.
srcsource memory area.

Referenced by reverseCopy().

void DUNE::Utils::reverseCopy8b ( char *  dest,
const char *  src 
)
inline

Copy eight bytes of a memory area while reversing the order of the bytes.

Parameters
destdestination memory area.
srcsource memory area.

Referenced by reverseCopy().

Variable Documentation

class DUNE_DLL_SYM DUNE::Utils::NMEAParser
struct DUNE_DLL_SYM DUNE::Utils::NMEASentence
class DUNE_DLL_SYM DUNE::Utils::OptionParser
class DUNE_DLL_SYM DUNE::Utils::RawFifo
class DUNE_DLL_SYM DUNE::Utils::String
class DUNE_DLL_SYM DUNE::Utils::TupleList