gpsppssync_OptionFile Class Reference

#include <gpsppssync_OptionFile.h>

Inheritance diagram for gpsppssync_OptionFile:

OptionFile

Detailed Description

A derived option file class for the program.

Definition at line 45 of file gpsppssync_OptionFile.h.


Public Member Functions

 gpsppssync_OptionFile ()
 The default constructor (no data allocated yet).
virtual ~gpsppssync_OptionFile ()
 The destructor.
bool ReadAndInterpretOptions (std::string OptionFilePath)
 Read and interpret the option file.

Data Fields

std::string m_OptionFilePath
 The path to the option file.
unsigned m_SerialPortNumber
 The serial port number.
bool m_PerformPPSTest
 A boolean to indicate if the pulse per second test is to be performed.
bool m_AllowTimeForHyperTerminalComparison
std::string m_ReceiverType
 The receiver type.
unsigned m_ReceiverSerialPortNumber
 The receiver serial port number on which data is collected.

Constructor & Destructor Documentation

gpsppssync_OptionFile::gpsppssync_OptionFile (  ) 

The default constructor (no data allocated yet).

Definition at line 46 of file gpsppssync_OptionFile.cpp.

gpsppssync_OptionFile::~gpsppssync_OptionFile (  )  [virtual]

The destructor.

Definition at line 41 of file gpsppssync_OptionFile.cpp.


Member Function Documentation

bool gpsppssync_OptionFile::ReadAndInterpretOptions ( std::string  OptionFilePath  ) 

Read and interpret the option file.

Returns:
true if successful, false if error.

Definition at line 52 of file gpsppssync_OptionFile.cpp.


Field Documentation

std::string gpsppssync_OptionFile::m_OptionFilePath

The path to the option file.

Definition at line 72 of file gpsppssync_OptionFile.h.

unsigned gpsppssync_OptionFile::m_SerialPortNumber

The serial port number.

Definition at line 75 of file gpsppssync_OptionFile.h.

bool gpsppssync_OptionFile::m_PerformPPSTest

A boolean to indicate if the pulse per second test is to be performed.

Definition at line 78 of file gpsppssync_OptionFile.h.

bool gpsppssync_OptionFile::m_AllowTimeForHyperTerminalComparison

A boolean to indicate if 40s of time output and audible dings are to be used for manual synchronization comparison.

Definition at line 82 of file gpsppssync_OptionFile.h.

std::string gpsppssync_OptionFile::m_ReceiverType

The receiver type.

Definition at line 85 of file gpsppssync_OptionFile.h.

unsigned gpsppssync_OptionFile::m_ReceiverSerialPortNumber

The receiver serial port number on which data is collected.

Definition at line 88 of file gpsppssync_OptionFile.h.


The documentation for this class was generated from the following files:
SourceForge.net Logo