Public Member Functions | List of all members
gplib::MtuFormat Class Reference

Read and write phoenix mtu binary files. More...

#include <MtuFormat.h>

Inheritance diagram for gplib::MtuFormat:
Inheritance graph

Public Member Functions

void MakeGood ()
 remove the "bad" flag from the header More...
 MtuFormat ()
virtual ~MtuFormat ()
virtual void GetData (const std::string filename)
virtual void GetData ()
virtual void WriteData (const std::string filename)
MtuFormatoperator= (MtuFormat &source)
MtuFormatoperator= (TimeSeries &source)
- Public Member Functions inherited from gplib::TimeSeries
TimeSeriesComponentGetHx ()
 Access function for Hx, returns reference for efficiency. More...
TimeSeriesComponentGetHy ()
TimeSeriesComponentGetHz ()
TimeSeriesComponentGetEx ()
TimeSeriesComponentGetEy ()
ttimedataGetTime ()
size_t Size ()
 Return the size of the time series, throws if one of the components has a different size. More...
double GetSamplerate ()
 The samplerate is stored in each component, we just return the samplerate of Hx assuming they are all equal. More...
 TimeSeries ()
virtual ~TimeSeries ()
TimeSeriesoperator= (const TimeSeries &source)
TimeSeriesoperator*= (const double &factor)
 Multiply all components by a constant factor. More...
TimeSeriesoperator+= (const double &shift)
 Add a constant shift to all components. More...
void erase (const int startindex, const int endindex)
 Erase data between startindex and endindex. More...

Additional Inherited Members

- Public Types inherited from gplib::TimeSeries
typedef boost::posix_time::ptime ttime
 We use the boost library time functionality for time types and store the time for each point in a vector. More...
typedef std::vector< ttimettimedata
- Protected Attributes inherited from gplib::TimeSeries
TimeSeriesComponent Hx
 The data for the north-south magnetic field. More...
TimeSeriesComponent Hy
 The data for the east-west magnetic field. More...
TimeSeriesComponent Hz
 The data for the vertical magnetic field. More...
TimeSeriesComponent Ex
 The data for the north-south electric field. More...
TimeSeriesComponent Ey
 The data for the east-west electric field. More...
ttimedata t
 The time associated with each data point. More...

Detailed Description

Read and write phoenix mtu binary files.

Definition at line 13 of file MtuFormat.h.

Constructor & Destructor Documentation

gplib::MtuFormat::MtuFormat ( )

Definition at line 15 of file MtuFormat.cpp.

gplib::MtuFormat::~MtuFormat ( )

Definition at line 19 of file MtuFormat.cpp.

Member Function Documentation

void gplib::MtuFormat::GetData ( const std::string  filename)

Declaration for GetData() that reads data from a file. This is intended for use with external data, such as recorded data, or synthetic data from external programs.

Implements gplib::TimeSeries.

Definition at line 137 of file MtuFormat.cpp.

void gplib::MtuFormat::GetData ( )

Definition at line 153 of file MtuFormat.cpp.

void gplib::MtuFormat::MakeGood ( )

remove the "bad" flag from the header

Definition at line 158 of file MtuFormat.cpp.

MtuFormat & gplib::MtuFormat::operator= ( MtuFormat source)

Definition at line 248 of file MtuFormat.cpp.

MtuFormat & gplib::MtuFormat::operator= ( TimeSeries source)

Definition at line 257 of file MtuFormat.cpp.

void gplib::MtuFormat::WriteData ( const std::string  filename)

The abstract declaration for a method that writes the data to a file. Therefore no version without a filename is present

Implements gplib::TimeSeries.

Definition at line 200 of file MtuFormat.cpp.

References gplib::tagsize.

The documentation for this class was generated from the following files: