Template Class for doing an FFT using the RDM FFT implementation. More...

#include "rdm_time_series_fft.h"

Inheritance diagram for RDM::TIME_SERIES::fft_rdm< N, RANGE_T, INDATA_T, NEXT >:

Collaboration diagram for RDM::TIME_SERIES::fft_rdm< N, RANGE_T, INDATA_T, NEXT >:

Protected Member Functions
RDM_RETCODE	init (RDM_DB db)
	Initialize this object. More...

	fft_rdm ()

	~fft_rdm ()

Protected Member Functions inherited from RDM::TIME_SERIES::fft< N, RANGE_T, INDATA_T, NEXT >
virtual RDM_RETCODE	doFft (void)=0

uint32_t	init_tables_to_write_lock (RDM_TABLE_ID *tables)
	ID of the tables where rows are inserted. More...

uint32_t	init_tables_to_read_lock (RDM_TABLE_ID *tables)
	IDs of the tables where rows are read. More...

void	unput (void)
	Undo a previous put operation. More...

void	unflush (void)
	Undo a previous flush operation. More...

RDM_RETCODE	init (RDM_DB db)
	Initialize this object. More...

Protected Attributes
RDM_FFT	fft_engine

Protected Attributes inherited from RDM::TIME_SERIES::fft< N, RANGE_T, INDATA_T, NEXT >
INDATA_T	in_data [N]

RANGE_T	aggregate_range

uint32_t	n

Additional Inherited Members
Public Member Functions inherited from RDM::TIME_SERIES::fft< N, RANGE_T, INDATA_T, NEXT >
void	reset (void)
	Reset this object. More...

RDM_RETCODE	flush_value (uint32_t threshold=1, RDM::DB::TRANSACTIONAL_T transactional=RDM::DB::NOT_TRANSACTIONAL)
	Flush this object. More...

RDM_RETCODE	flush_stats (uint32_t threshold=1, RDM::DB::TRANSACTIONAL_T transactional=RDM::DB::NOT_TRANSACTIONAL)
	Flush this object. More...

template<class SOURCE_VALUE_T >
RDM_RETCODE	put_value (SOURCE_VALUE_T *source_value, RDM::DB::TRANSACTIONAL_T transactional=RDM::DB::NOT_TRANSACTIONAL)
	Template method for receiving a data value. More...

template<class SOURCE_STATS_T >
RDM_RETCODE	put_stats (SOURCE_STATS_T *source_stats, RDM::DB::TRANSACTIONAL_T transactional=RDM::DB::NOT_TRANSACTIONAL)
	Template method for receiving statistics. More...

Static Protected Member Functions inherited from RDM::TIME_SERIES::fft< N, RANGE_T, INDATA_T, NEXT >
constexpr static int	number_of_tables_to_write_lock (void)
	Number of tables where rows are inserted. More...

constexpr static int	number_of_tables_to_read_lock (void)
	Number of tables where rows are read. More...

Detailed Description

template<uint32_t N, class RANGE_T, class INDATA_T, class NEXT>
class RDM::TIME_SERIES::fft_rdm< N, RANGE_T, INDATA_T, NEXT >

Template Class for doing an FFT using the RDM FFT implementation.

Template class for FFT of data values, ranges, or statistics. What is received will be collected and used for doing FFT computations. The result of those computations will be forwarded to the next class in the chain.

This class is taylored towards the RDM implementation for doing an FFT. It is also incomplete as it does not have the code for doing the actual FFT computation. Use one of the following derived classes:

Template Parameters

N	The number of data points for each FFT computation. In the case ranges are received, then N must fit its size.
RANGE_T	The aggregate FFT class for which objects will be passed to the next class. The size of this range is implementation-dependent.
INDATA_T	The type of the data that is passed to this class.
NEXT	The class in the chain to receive the result of the FFT computations.

Constructor & Destructor Documentation

fft_rdm()

template<uint32_t N, class RANGE_T , class INDATA_T , class NEXT >

RDM::TIME_SERIES::fft_rdm< N, RANGE_T, INDATA_T, NEXT >::fft_rdm ( )

inlineprotected

 : fft_inited (false)
 {
 }

~fft_rdm()

template<uint32_t N, class RANGE_T , class INDATA_T , class NEXT >

RDM::TIME_SERIES::fft_rdm< N, RANGE_T, INDATA_T, NEXT >::~fft_rdm ( )

inlineprotected

 {
if (fft_inited == true)
 {
rdm_fftTerm (&fft_engine);
 }
 }

References RDM::TIME_SERIES::fft_rdm< N, RANGE_T, INDATA_T, NEXT >::fft_engine, and rdm_fftTerm().

Here is the call graph for this function:

Member Function Documentation

init()

template<uint32_t N, class RANGE_T , class INDATA_T , class NEXT >

RDM_RETCODE RDM::TIME_SERIES::fft_rdm< N, RANGE_T, INDATA_T, NEXT >::init ( RDM_DB db )

inlineprotected

Initialize this object.

Call this method before sending it any data values, ranges, or statistics.

Return values

sOKAY	Normal, successful return.
eINVARG	Invalid argument.
eDBNOTOPEN	Database not open.
eCURSORDB	Cursor is associated with a different database.
ePRECOMMITTED	A precommitted transaction must be committed or rolled back before further operations on this database are allowed.

Parameters

db	[IN] Use this database for chained classes that need to insert rows

 {
RDM_RETCODE rc = rdm_fftInit (
 &fft_engine, N, RDM_FFT_FORWARD, (RDM_FFT_DATA *) fft_work,
 (RDM_FFT_DATA *) fft_data, (RDM_FFT_DATA *) fft_data);

if (rc == sOKAY)
 {
 rc = fft<N, RANGE_T, INDATA_T, NEXT>::init (db);

if (rc != sOKAY)
 {
rdm_fftTerm (&fft_engine);
 }
 }

if (rc == sOKAY)
 {
 fft_inited = true;
 }

return rc;
 }