GPLIB++
Public Member Functions | List of all members
gplib::LemiTsFormat Class Reference

Read and write ascii files produced by the LEMI instruments. More...

#include <LemiTsFormat.h>

Inheritance diagram for gplib::LemiTsFormat:
Inheritance graph
[legend]

Public Member Functions

 LemiTsFormat ()
 
virtual ~LemiTsFormat ()
 
virtual void GetData ()
 
virtual void GetData (const std::string filename)
 
virtual void WriteData (const std::string filename)
 
LemiTsFormatoperator= (BirrpAsciiFormat &source)
 
LemiTsFormatoperator= (MtuFormat &source)
 
LemiTsFormatoperator= (TimeSeries &source)
 
LemiTsFormatoperator= (LemiTsFormat &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 ascii files produced by the LEMI instruments.

Definition at line 15 of file LemiTsFormat.h.

Constructor & Destructor Documentation

gplib::LemiTsFormat::LemiTsFormat ( )

Definition at line 12 of file LemiTsFormat.cpp.

gplib::LemiTsFormat::~LemiTsFormat ( )
virtual

Definition at line 16 of file LemiTsFormat.cpp.

Member Function Documentation

void gplib::LemiTsFormat::GetData ( )
virtual

Definition at line 20 of file LemiTsFormat.cpp.

void gplib::LemiTsFormat::GetData ( const std::string  filename)
virtual

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 25 of file LemiTsFormat.cpp.

LemiTsFormat & gplib::LemiTsFormat::operator= ( BirrpAsciiFormat source)

Definition at line 76 of file LemiTsFormat.cpp.

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

Definition at line 82 of file LemiTsFormat.cpp.

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

Definition at line 88 of file LemiTsFormat.cpp.

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

Definition at line 94 of file LemiTsFormat.cpp.

void gplib::LemiTsFormat::WriteData ( const std::string  filename)
virtual

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 71 of file LemiTsFormat.cpp.

Referenced by gplib::TimeSeriesData::WriteAsLemi().


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