ldas-tools-frameAPI  2.6.5
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
ReduceRawFrame Class Reference

#include <rdsreduce.hh>

Inheritance diagram for ReduceRawFrame:
Inheritance graph
[legend]
Collaboration diagram for ReduceRawFrame:
Collaboration graph
[legend]

Public Member Functions

 ReduceRawFrame (const char *frame_files, const char *channels, const RDSFrame::Options &UserOptions)
 Constructor. More...
 
 ReduceRawFrame (const frame_file_container_type &frame_files, const channel_container_type &channels, const RDSFrame::Options &UserOptions)
 Constructor. More...
 
virtual ~ReduceRawFrame ()
 Destructor. More...
 
virtual void writeFrameToStream ()
 
 ReduceRawFrame (const char *frame_files, const char *channels, const RDSFrame::Options &UserOptions)
 Constructor. More...
 
 ReduceRawFrame (const frame_file_container_type &frame_files, const channel_container_type &channels, const RDSFrame::Options &UserOptions)
 Constructor. More...
 
virtual ~ReduceRawFrame ()
 Destructor. More...
 
virtual void writeFrameToStream ()
 
 ReduceRawFrame (const char *frame_files, const char *channels, const RDSFrame::Options &UserOptions)
 Constructor. More...
 
 ReduceRawFrame (const frame_file_container_type &frame_files, const channel_container_type &channels, const RDSFrame::Options &UserOptions)
 Constructor. More...
 
virtual ~ReduceRawFrame ()
 Destructor. More...
 
virtual void writeFrameToStream ()
 

Protected Member Functions

virtual void processChannel (fr_adc_data_type Adc)
 
virtual void processChannel (fr_proc_data_type Proc)
 
virtual void rangeOptimizer (const time_type &UserStart, const time_type &UserStop, time_type &DataStart, time_type &DataStop) const
 
virtual stop_request_type stopRequest () const
 
virtual void processChannel (fr_adc_data_type Adc)
 
virtual void processChannel (fr_proc_data_type Proc)
 
virtual void rangeOptimizer (const time_type &UserStart, const time_type &UserStop, time_type &DataStart, time_type &DataStop) const
 
virtual stop_request_type stopRequest () const
 
virtual void processChannel (fr_adc_data_type Adc)
 
virtual void processChannel (fr_proc_data_type Proc)
 
virtual void rangeOptimizer (const time_type &UserStart, const time_type &UserStop, time_type &DataStart, time_type &DataStop) const
 
virtual stop_request_type stopRequest () const
 

Private Types

enum  stop_request_type {
  STOP_DATA, STOP_USER, STOP_DATA, STOP_USER,
  STOP_DATA, STOP_USER
}
 
enum  stop_request_type {
  STOP_DATA, STOP_USER, STOP_DATA, STOP_USER,
  STOP_DATA, STOP_USER
}
 
enum  stop_request_type {
  STOP_DATA, STOP_USER, STOP_DATA, STOP_USER,
  STOP_DATA, STOP_USER
}
 
typedef std::vector< std::string > frame_file_container_type
 
typedef std::vector< std::string > frame_file_container_type
 
typedef std::vector< std::string > frame_file_container_type
 
typedef std::vector< std::string > channel_container_type
 
typedef std::vector< std::string > channel_container_type
 
typedef std::vector< std::string > channel_container_type
 
typedef ::FrameAPI::RDS::Options Options
 
typedef ::FrameAPI::RDS::Options Options
 
typedef ::FrameAPI::RDS::Options Options
 
typedef boost::shared_ptr< RDSStreamstream_type
 
typedef boost::shared_ptr< RDSStreamstream_type
 
typedef boost::shared_ptr< RDSStreamstream_type
 
typedef LDASTools::AL::GPSTime time_type
 
typedef LDASTools::AL::GPSTime time_type
 
typedef LDASTools::AL::GPSTime time_type
 
typedef boost::shared_ptr< FrameCPP::FrameH > frame_h_type
 
typedef boost::shared_ptr< FrameCPP::FrameH > frame_h_type
 
typedef boost::shared_ptr< FrameCPP::FrameH > frame_h_type
 
typedef boost::shared_ptr< FrameCPP::FrAdcData > fr_adc_data_type
 
typedef boost::shared_ptr< FrameCPP::FrAdcData > fr_adc_data_type
 
typedef boost::shared_ptr< FrameCPP::FrAdcData > fr_adc_data_type
 
typedef boost::shared_ptr< FrameCPP::FrProcData > fr_proc_data_type
 
typedef boost::shared_ptr< FrameCPP::FrProcData > fr_proc_data_type
 
typedef boost::shared_ptr< FrameCPP::FrProcData > fr_proc_data_type
 
typedef std::vector< std::string >::const_iterator stringv_const_iterator
 
typedef std::vector< std::string >::const_iterator stringv_const_iterator
 
typedef std::vector< std::string >::const_iterator stringv_const_iterator
 

Private Member Functions

INT_4U GetNumberOfChannels () const
 
INT_4U GetNumberOfChannels () const
 
INT_4U GetNumberOfChannels () const
 
INT_4U GetNumberOfFrameGroups () const
 
INT_4U GetNumberOfFrameGroups () const
 
INT_4U GetNumberOfFrameGroups () const
 
INT_4U GetNumberOfFrameFiles () const
 
INT_4U GetNumberOfFrameFiles () const
 
INT_4U GetNumberOfFrameFiles () const
 
void ProcessRequest (stream_type Output)
 
void ProcessRequest (stream_type Output)
 
void ProcessRequest (stream_type Output)
 
template<typename Functor >
void foreachChannel (Functor &Func) const
 
template<typename Functor >
void foreachChannel (Functor &Func) const
 
template<typename Functor >
void foreachChannel (Functor &Func) const
 
FrameCPP::FrameH::procData_type * getResultProcData ()
 
FrameCPP::FrameH::procData_type * getResultProcData ()
 
FrameCPP::FrameH::procData_type * getResultProcData ()
 
virtual void createHistory ()
 
virtual void createHistory ()
 
virtual void createHistory ()
 
const std::string & getChannelName (INT_4U Offset) const
 
const std::string & getChannelName (INT_4U Offset) const
 
const std::string & getChannelName (INT_4U Offset) const
 

Static Private Member Functions

static FrameCPP::FrProcData * getProcChannel (const std::string &name, FrameCPP::FrameH::procData_type *const proc)
 return: FrameCPP::FrProcData* - A pointer to the channel object. More...
 
static FrameCPP::FrProcData * getProcChannel (const std::string &name, FrameCPP::FrameH::procData_type *const proc)
 
static FrameCPP::FrProcData * getProcChannel (const std::string &name, FrameCPP::FrameH::procData_type *const proc)
 
static const std::string & getHistoryName ()
 
static const std::string & getHistoryName ()
 
static const std::string & getHistoryName ()
 

Private Attributes

Options m_options
 
frame_h_type mResultFrame
 
boost::shared_ptr< RDSStreamm_stream
 

Member Typedef Documentation

◆ channel_container_type [1/3]

typedef std::vector< std::string > RDSFrame::channel_container_type
inherited

◆ channel_container_type [2/3]

typedef std::vector< std::string > RDSFrame::channel_container_type
inherited

◆ channel_container_type [3/3]

typedef std::vector< std::string > RDSFrame::channel_container_type
inherited

◆ fr_adc_data_type [1/3]

typedef boost::shared_ptr< FrameCPP::FrAdcData > RDSFrame::fr_adc_data_type
protectedinherited

◆ fr_adc_data_type [2/3]

typedef boost::shared_ptr< FrameCPP::FrAdcData > RDSFrame::fr_adc_data_type
protectedinherited

◆ fr_adc_data_type [3/3]

typedef boost::shared_ptr< FrameCPP::FrAdcData > RDSFrame::fr_adc_data_type
protectedinherited

◆ fr_proc_data_type [1/3]

typedef boost::shared_ptr< FrameCPP::FrProcData > RDSFrame::fr_proc_data_type
protectedinherited

◆ fr_proc_data_type [2/3]

typedef boost::shared_ptr< FrameCPP::FrProcData > RDSFrame::fr_proc_data_type
protectedinherited

◆ fr_proc_data_type [3/3]

typedef boost::shared_ptr< FrameCPP::FrProcData > RDSFrame::fr_proc_data_type
protectedinherited

◆ frame_file_container_type [1/3]

typedef std::vector< std::string > RDSFrame::frame_file_container_type
inherited

◆ frame_file_container_type [2/3]

typedef std::vector< std::string > RDSFrame::frame_file_container_type
inherited

◆ frame_file_container_type [3/3]

typedef std::vector< std::string > RDSFrame::frame_file_container_type
inherited

◆ frame_h_type [1/3]

typedef boost::shared_ptr< FrameCPP::FrameH > RDSFrame::frame_h_type
protectedinherited

◆ frame_h_type [2/3]

typedef boost::shared_ptr< FrameCPP::FrameH > RDSFrame::frame_h_type
protectedinherited

◆ frame_h_type [3/3]

typedef boost::shared_ptr< FrameCPP::FrameH > RDSFrame::frame_h_type
protectedinherited

◆ Options [1/3]

◆ Options [2/3]

◆ Options [3/3]

◆ stream_type [1/3]

typedef boost::shared_ptr< RDSStream > RDSFrame::stream_type
inherited

◆ stream_type [2/3]

typedef boost::shared_ptr< RDSStream > RDSFrame::stream_type
inherited

◆ stream_type [3/3]

typedef boost::shared_ptr< RDSStream > RDSFrame::stream_type
inherited

◆ stringv_const_iterator [1/3]

typedef std::vector< std::string >::const_iterator RDSFrame::stringv_const_iterator
protectedinherited

◆ stringv_const_iterator [2/3]

typedef std::vector< std::string >::const_iterator RDSFrame::stringv_const_iterator
protectedinherited

◆ stringv_const_iterator [3/3]

typedef std::vector< std::string >::const_iterator RDSFrame::stringv_const_iterator
protectedinherited

◆ time_type [1/3]

typedef LDASTools::AL::GPSTime RDSFrame::time_type
protectedinherited

◆ time_type [2/3]

typedef LDASTools::AL::GPSTime RDSFrame::time_type
protectedinherited

◆ time_type [3/3]

typedef LDASTools::AL::GPSTime RDSFrame::time_type
protectedinherited

Member Enumeration Documentation

◆ stop_request_type [1/3]

enum RDSFrame::stop_request_type
protectedinherited
Enumerator
STOP_DATA 
STOP_USER 
STOP_DATA 
STOP_USER 
STOP_DATA 
STOP_USER 

◆ stop_request_type [2/3]

enum RDSFrame::stop_request_type
protectedinherited
Enumerator
STOP_DATA 
STOP_USER 
STOP_DATA 
STOP_USER 
STOP_DATA 
STOP_USER 

◆ stop_request_type [3/3]

enum RDSFrame::stop_request_type
protectedinherited
Enumerator
STOP_DATA 
STOP_USER 
STOP_DATA 
STOP_USER 
STOP_DATA 
STOP_USER 

Constructor & Destructor Documentation

◆ ReduceRawFrame() [1/6]

ReduceRawFrame::ReduceRawFrame ( const char *  frame_files,
const char *  channels,
const RDSFrame::Options UserOptions 
)

Constructor.

Parameters
[in]frame_filesA list of frame file names.
[in]channelsA list of channels to extract from original frames (only channel names are allowed).
[in]UserOptionsUser specified options.
Returns
New instance of this object.

◆ ReduceRawFrame() [2/6]

ReduceRawFrame::ReduceRawFrame ( const frame_file_container_type frame_files,
const channel_container_type channels,
const RDSFrame::Options UserOptions 
)

Constructor.

Parameters
[in]frame_filesA list of frame file names.
[in]channelsA list of channels to extract from original frames (only channel names are allowed).
[in]UserOptionsUser specified options.
Returns
New instance of this object.

◆ ~ReduceRawFrame() [1/3]

ReduceRawFrame::~ReduceRawFrame ( )
virtual

Destructor.

◆ ReduceRawFrame() [3/6]

ReduceRawFrame::ReduceRawFrame ( const char *  frame_files,
const char *  channels,
const RDSFrame::Options UserOptions 
)

Constructor.

Parameters
[in]frame_filesA list of frame file names.
[in]channelsA list of channels to extract from original frames (only channel names are allowed).
[in]UserOptionsUser specified options.
Returns
New instance of this object.

◆ ReduceRawFrame() [4/6]

ReduceRawFrame::ReduceRawFrame ( const frame_file_container_type frame_files,
const channel_container_type channels,
const RDSFrame::Options UserOptions 
)

Constructor.

Parameters
[in]frame_filesA list of frame file names.
[in]channelsA list of channels to extract from original frames (only channel names are allowed).
[in]UserOptionsUser specified options.
Returns
New instance of this object.

◆ ~ReduceRawFrame() [2/3]

virtual ReduceRawFrame::~ReduceRawFrame ( )
virtual

Destructor.

◆ ReduceRawFrame() [5/6]

ReduceRawFrame::ReduceRawFrame ( const char *  frame_files,
const char *  channels,
const RDSFrame::Options UserOptions 
)

Constructor.

Parameters
[in]frame_filesA list of frame file names.
[in]channelsA list of channels to extract from original frames (only channel names are allowed).
[in]UserOptionsUser specified options.
Returns
New instance of this object.

◆ ReduceRawFrame() [6/6]

ReduceRawFrame::ReduceRawFrame ( const frame_file_container_type frame_files,
const channel_container_type channels,
const RDSFrame::Options UserOptions 
)

Constructor.

Parameters
[in]frame_filesA list of frame file names.
[in]channelsA list of channels to extract from original frames (only channel names are allowed).
[in]UserOptionsUser specified options.
Returns
New instance of this object.

◆ ~ReduceRawFrame() [3/3]

virtual ReduceRawFrame::~ReduceRawFrame ( )
virtual

Destructor.

Member Function Documentation

◆ createHistory() [1/3]

void RDSFrame::createHistory ( )
protectedvirtualinherited

◆ createHistory() [2/3]

virtual void RDSFrame::createHistory ( )
protectedvirtualinherited

◆ createHistory() [3/3]

virtual void RDSFrame::createHistory ( )
protectedvirtualinherited

◆ foreachChannel() [1/3]

template<typename Functor >
void RDSFrame::foreachChannel ( Functor &  Func) const
inlineprotectedinherited

◆ foreachChannel() [2/3]

template<typename Functor >
void RDSFrame::foreachChannel ( Functor &  Func) const
inlineprotectedinherited

◆ foreachChannel() [3/3]

template<typename Functor >
void RDSFrame::foreachChannel ( Functor &  Func) const
inlineprotectedinherited

◆ getChannelName() [1/3]

const std::string & RDSFrame::getChannelName ( INT_4U  Offset) const
protectedinherited

◆ getChannelName() [2/3]

const std::string& RDSFrame::getChannelName ( INT_4U  Offset) const
protectedinherited

◆ getChannelName() [3/3]

const std::string& RDSFrame::getChannelName ( INT_4U  Offset) const
protectedinherited

◆ getHistoryName() [1/3]

static const std::string& RDSFrame::getHistoryName ( )
staticprotectedinherited

◆ getHistoryName() [2/3]

static const std::string& RDSFrame::getHistoryName ( )
staticprotectedinherited

◆ getHistoryName() [3/3]

const std::string & RDSFrame::getHistoryName ( )
staticprotectedinherited

◆ GetNumberOfChannels() [1/3]

INT_4U RDSFrame::GetNumberOfChannels ( ) const
inherited

◆ GetNumberOfChannels() [2/3]

INT_4U RDSFrame::GetNumberOfChannels ( ) const
inherited

◆ GetNumberOfChannels() [3/3]

INT_4U RDSFrame::GetNumberOfChannels ( ) const
inherited

◆ GetNumberOfFrameFiles() [1/3]

INT_4U RDSFrame::GetNumberOfFrameFiles ( ) const
inherited

◆ GetNumberOfFrameFiles() [2/3]

INT_4U RDSFrame::GetNumberOfFrameFiles ( ) const
inherited

◆ GetNumberOfFrameFiles() [3/3]

INT_4U RDSFrame::GetNumberOfFrameFiles ( ) const
inherited

◆ GetNumberOfFrameGroups() [1/3]

INT_4U RDSFrame::GetNumberOfFrameGroups ( ) const
inherited

◆ GetNumberOfFrameGroups() [2/3]

INT_4U RDSFrame::GetNumberOfFrameGroups ( ) const
inherited

◆ GetNumberOfFrameGroups() [3/3]

INT_4U RDSFrame::GetNumberOfFrameGroups ( ) const
inherited

◆ getProcChannel() [1/3]

static FrameCPP::FrProcData* RDSFrame::getProcChannel ( const std::string &  name,
FrameCPP::FrameH::procData_type *const  proc 
)
staticprotectedinherited

◆ getProcChannel() [2/3]

static FrameCPP::FrProcData* RDSFrame::getProcChannel ( const std::string &  name,
FrameCPP::FrameH::procData_type *const  proc 
)
staticprotectedinherited

◆ getProcChannel() [3/3]

FrameCPP::FrProcData * RDSFrame::getProcChannel ( const std::string &  name,
FrameCPP::FrameH::procData_type *const  proc 
)
staticprotectedinherited

return: FrameCPP::FrProcData* - A pointer to the channel object.

param: const std::string& name - Channel name. param: const FrameCPP::FrameH::procData_type* proc - A pointer to theexc: Channel not found: name. - Specified channel is not found.

◆ getResultProcData() [1/3]

FrameCPP::FrameH::procData_type * RDSFrame::getResultProcData ( )
inlineprotectedinherited

◆ getResultProcData() [2/3]

FrameCPP::FrameH::procData_type* RDSFrame::getResultProcData ( )
protectedinherited

◆ getResultProcData() [3/3]

FrameCPP::FrameH::procData_type* RDSFrame::getResultProcData ( )
protectedinherited

◆ processChannel() [1/6]

void ReduceRawFrame::processChannel ( fr_adc_data_type  Adc)
protectedvirtual

Implements RDSFrame.

◆ processChannel() [2/6]

virtual void ReduceRawFrame::processChannel ( fr_adc_data_type  Adc)
protectedvirtual

Implements RDSFrame.

◆ processChannel() [3/6]

virtual void ReduceRawFrame::processChannel ( fr_adc_data_type  Adc)
protectedvirtual

Implements RDSFrame.

◆ processChannel() [4/6]

virtual void ReduceRawFrame::processChannel ( fr_proc_data_type  Proc)
protectedvirtual

Implements RDSFrame.

◆ processChannel() [5/6]

virtual void ReduceRawFrame::processChannel ( fr_proc_data_type  Proc)
protectedvirtual

Implements RDSFrame.

◆ processChannel() [6/6]

void ReduceRawFrame::processChannel ( fr_proc_data_type  Proc)
protectedvirtual

Implements RDSFrame.

◆ ProcessRequest() [1/3]

void RDSFrame::ProcessRequest ( stream_type  Output)
inherited

◆ ProcessRequest() [2/3]

void RDSFrame::ProcessRequest ( stream_type  Output)
inherited

◆ ProcessRequest() [3/3]

void RDSFrame::ProcessRequest ( stream_type  Output)
inherited

◆ rangeOptimizer() [1/3]

virtual void ReduceRawFrame::rangeOptimizer ( const time_type UserStart,
const time_type UserStop,
time_type DataStart,
time_type DataStop 
) const
protectedvirtual

Implements RDSFrame.

◆ rangeOptimizer() [2/3]

virtual void ReduceRawFrame::rangeOptimizer ( const time_type UserStart,
const time_type UserStop,
time_type DataStart,
time_type DataStop 
) const
protectedvirtual

Implements RDSFrame.

◆ rangeOptimizer() [3/3]

void ReduceRawFrame::rangeOptimizer ( const time_type UserStart,
const time_type UserStop,
time_type DataStart,
time_type DataStop 
) const
protectedvirtual

Implements RDSFrame.

◆ stopRequest() [1/3]

virtual stop_request_type ReduceRawFrame::stopRequest ( ) const
protectedvirtual

Implements RDSFrame.

◆ stopRequest() [2/3]

virtual stop_request_type ReduceRawFrame::stopRequest ( ) const
protectedvirtual

Implements RDSFrame.

◆ stopRequest() [3/3]

ReduceRawFrame::stop_request_type ReduceRawFrame::stopRequest ( ) const
protectedvirtual

Implements RDSFrame.

◆ writeFrameToStream() [1/3]

void ReduceRawFrame::writeFrameToStream ( )
virtual

Reimplemented from RDSFrame.

◆ writeFrameToStream() [2/3]

virtual void ReduceRawFrame::writeFrameToStream ( )
virtual

Reimplemented from RDSFrame.

◆ writeFrameToStream() [3/3]

virtual void ReduceRawFrame::writeFrameToStream ( )
virtual

Reimplemented from RDSFrame.

Member Data Documentation

◆ m_options

Options RDSFrame::m_options
protectedinherited

◆ m_stream

boost::shared_ptr< RDSStream > RDSFrame::m_stream
protectedinherited

◆ mResultFrame

frame_h_type RDSFrame::mResultFrame
protectedinherited

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