Field Class Reference

#include <NMEA.h>

List of all members.


Detailed Description

Field represents a generic NMEA field.

A field can have one of several types There are set/get methods that are used to change or access the field's values.

See also:
Field::FieldType

Public Types

enum  FIELD_TYPES {
  INT = 0, UINT, DOUBLE, UCHAR,
  CHAR, PCHAR, TIMET, DATET
}
 NMEA field type enum.
typedef enum Field::FIELD_TYPES FieldType
 Field data type enumeration.

Public Member Functions

 Field ()
 Default no argument constructor.
 Field (char *value)
 Character pointer constructor.
 Field (char value)
 Character constructor.
 Field (int value)
 Integer constructor.
 Field (unsigned int value)
 Unsigned integer constructor.
 Field (double value)
 Double constructor.
 Field (unsigned char value)
 Unsigned char constructor.
 Field (time_t value)
 time_t constructor
FieldType getType ()
 
Returns:
field type

char * pcharValue ()
 return _pcharValue member variable
int intValue ()
 return _intValue member variable
unsigned int uintValue ()
 
Returns:
_uintValue member variable

unsigned char ucharValue ()
 
Returns:
_ucharValue member variable

double doubleValue ()
 
Returns:
_doubleValue member variable

time_t timeValue ()
 
Returns:
_timeValue member variable

void setValue (int value)
 set _intValue member variable
void setValue (unsigned int value)
 set _uintValue member variable
void setValue (char *value)
 set _pcharValue member variable
void setValue (char value)
 set _charValue member variable
void setValue (unsigned char value)
 set _ucharValue member variable
void setValue (double value)
 set _doubleValue member variable
void setValue (time_t value)
 set _timeValue member variable
const char * toString () const
 Represent Field as string.

Private Attributes

FieldType _type
 Primitive data type of this field.
char * _name
 Field name.
char * _pcharValue
 char ptr value
char _charValue
 char value
int _intValue
 int value
unsigned int _uintValue
 uint value
unsigned char _ucharValue
 uchar value
double _doubleValue
 double value
time_t _timeValue
 time_t value

Friends

ostream & operator<< (ostream &output, const Field &n)
 output stream operator.

Constructor & Destructor Documentation

Field::Field ( char *  value  ) 

Character pointer constructor.

Parameters:
value - initial value

Field::Field ( char  value  ) 

Character constructor.

Parameters:
value - initial value

Field::Field ( int  value  ) 

Integer constructor.

Parameters:
value - initial value

Field::Field ( unsigned int  value  ) 

Unsigned integer constructor.

Parameters:
value - initial value

Field::Field ( double  value  ) 

Double constructor.

Parameters:
value - initial value

Field::Field ( unsigned char  value  ) 

Unsigned char constructor.

Parameters:
value - initial value

Field::Field ( time_t  value  ) 

time_t constructor

Parameters:
value - initial value


Member Function Documentation

Field::FieldType Field::getType (  ) 

Returns:
field type

See also:
FieldType

void Field::setValue ( int  value  ) 

set _intValue member variable

Parameters:
value new value

void Field::setValue ( unsigned int  value  ) 

set _uintValue member variable

Parameters:
value new value

void Field::setValue ( char *  value  ) 

set _pcharValue member variable

Parameters:
value new value

void Field::setValue ( char  value  ) 

set _charValue member variable

Parameters:
value new value

void Field::setValue ( unsigned char  value  ) 

set _ucharValue member variable

Parameters:
value new value

void Field::setValue ( double  value  ) 

set _doubleValue member variable

Parameters:
value new value

void Field::setValue ( time_t  value  ) 

set _timeValue member variable

Parameters:
value new value

const char* Field::toString (  )  const [inline]

Represent Field as string.


Friends And Related Function Documentation

ostream& operator<< ( ostream &  output,
const Field n 
) [friend]

output stream operator.

Formats object for output stream insertion

Parameters:
output output stream handle
n Field object pointer


Member Data Documentation

FieldType Field::_type [private]

Primitive data type of this field.

See also:
FieldType.


The documentation for this class was generated from the following files:
Generated on Tue Jul 15 13:10:23 2008 for Benthic Imaging AUV by  doxygen 1.5.4