ldas-tools-frameAPI  2.5.1
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
RDSFrame Class Referenceabstract

Base functional to create RDS frames. More...

#include <rdsframe.hh>

Inheritance diagram for RDSFrame:
ReduceRawFrame ResampleRawFrame

Public Types

typedef std::vector< std::string > frame_file_container_type
 
typedef std::vector< std::string > channel_container_type
 
typedef ::FrameAPI::RDS::Options Options
 
typedef LDASTools::AL::SharedPtr< RDSStreamstream_type
 

Public Member Functions

 RDSFrame (const char *frame_files, const char *channels, const Options &CommandOptions)
 Constructor. More...
 
 RDSFrame (const frame_file_container_type &frame_files, const channel_container_type &channels, const Options &CommandOptions)
 Constructor. More...
 
virtual ~RDSFrame ()
 
INT_4U GetNumberOfChannels () const
 
INT_4U GetNumberOfFrameGroups () const
 
INT_4U GetNumberOfFrameFiles () const
 
void ProcessRequest (stream_type Output)
 

Protected Types

enum  stop_request_type { STOP_DATA, STOP_USER }
 
typedef LDASTools::AL::GPSTime time_type
 
typedef LDASTools::AL::SharedPtr< FrameCPP::FrameH > frame_h_type
 
typedef LDASTools::AL::SharedPtr< FrameCPP::FrAdcData > fr_adc_data_type
 
typedef LDASTools::AL::SharedPtr< FrameCPP::FrProcData > fr_proc_data_type
 
typedef std::vector< std::string >::const_iterator stringv_const_iterator
 

Protected Member Functions

 RDSFrame (const Options &CommandOptions)
 
virtual stop_request_type stopRequest () const =0
 
virtual void processChannel (fr_adc_data_type Adc)=0
 
virtual void processChannel (fr_proc_data_type Proc)=0
 
virtual void rangeOptimizer (const time_type &UserStart, const time_type &UserStop, time_type &DataStart, time_type &DataStop) const =0
 
virtual void writeFrameToStream ()
 
template<typename Functor >
void foreachChannel (Functor &Func) const
 
FrameCPP::FrameH::procData_type * getResultProcData ()
 
virtual void createHistory ()
 
const std::string & getChannelName (INT_4U Offset) const
 

Static Protected 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 const std::string & getHistoryName ()
 

Protected Attributes

Options m_options
 
frame_h_type mResultFrame
 
LDASTools::AL::SharedPtr< RDSStreamm_stream
 

Detailed Description

Base functional to create RDS frames.

Member Typedef Documentation

◆ channel_container_type

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

◆ fr_adc_data_type

typedef LDASTools::AL::SharedPtr< FrameCPP::FrAdcData > RDSFrame::fr_adc_data_type
protected

◆ fr_proc_data_type

typedef LDASTools::AL::SharedPtr< FrameCPP::FrProcData > RDSFrame::fr_proc_data_type
protected

◆ frame_file_container_type

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

◆ frame_h_type

typedef LDASTools::AL::SharedPtr< FrameCPP::FrameH > RDSFrame::frame_h_type
protected

◆ Options

◆ stream_type

typedef LDASTools::AL::SharedPtr< RDSStream > RDSFrame::stream_type

◆ stringv_const_iterator

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

◆ time_type

typedef LDASTools::AL::GPSTime RDSFrame::time_type
protected

Member Enumeration Documentation

◆ stop_request_type

Enumerator
STOP_DATA 
STOP_USER 

Constructor & Destructor Documentation

◆ RDSFrame() [1/3]

RDSFrame::RDSFrame ( const char *  frame_files,
const char *  channels,
const Options CommandOptions 
)

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]CommandOptionsCollection of flags used to direct the construction of the Reduced Data Set results.

◆ RDSFrame() [2/3]

RDSFrame::RDSFrame ( const frame_file_container_type frame_files,
const channel_container_type channels,
const Options CommandOptions 
)

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]CommandOptionsCollection of flags used to direct the construction of the Reduced Data Set results.

◆ ~RDSFrame()

RDSFrame::~RDSFrame ( )
virtual

◆ RDSFrame() [3/3]

RDSFrame::RDSFrame ( const Options CommandOptions)
protected

Member Function Documentation

◆ createHistory()

void RDSFrame::createHistory ( )
protectedvirtual

◆ foreachChannel()

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

◆ getChannelName()

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

◆ getHistoryName()

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

◆ GetNumberOfChannels()

INT_4U RDSFrame::GetNumberOfChannels ( ) const

◆ GetNumberOfFrameFiles()

INT_4U RDSFrame::GetNumberOfFrameFiles ( ) const

◆ GetNumberOfFrameGroups()

INT_4U RDSFrame::GetNumberOfFrameGroups ( ) const

◆ getProcChannel()

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

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()

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

◆ processChannel() [1/2]

virtual void RDSFrame::processChannel ( fr_adc_data_type  Adc)
protectedpure virtual

Implemented in ResampleRawFrame, and ReduceRawFrame.

◆ processChannel() [2/2]

virtual void RDSFrame::processChannel ( fr_proc_data_type  Proc)
protectedpure virtual

Implemented in ResampleRawFrame, and ReduceRawFrame.

◆ ProcessRequest()

void RDSFrame::ProcessRequest ( stream_type  Output)

◆ rangeOptimizer()

virtual void RDSFrame::rangeOptimizer ( const time_type UserStart,
const time_type UserStop,
time_type DataStart,
time_type DataStop 
) const
protectedpure virtual

Implemented in ReduceRawFrame.

◆ stopRequest()

virtual stop_request_type RDSFrame::stopRequest ( ) const
protectedpure virtual

Implemented in ResampleRawFrame, and ReduceRawFrame.

◆ writeFrameToStream()

void RDSFrame::writeFrameToStream ( )
protectedvirtual

Reimplemented in ReduceRawFrame.

Member Data Documentation

◆ m_options

Options RDSFrame::m_options
protected

◆ m_stream

LDASTools::AL::SharedPtr< RDSStream > RDSFrame::m_stream
protected

◆ mResultFrame

frame_h_type RDSFrame::mResultFrame
protected

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