Template Class for ignoring. More...
#include "rdm_time_series_dead_end.h"
Public Member Functions |
|
RDM_RETCODE | init (RDM_DB db) |
Initialize this object. More... |
|
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... |
|
RDM_RETCODE | flush_range (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... |
|
template<class SOURCE_RANGE_T > | |
RDM_RETCODE | put_range (SOURCE_RANGE_T *source_range, RDM::DB::TRANSACTIONAL_T transactional=RDM::DB::NOT_TRANSACTIONAL) |
Template method for receiving ranges. More... |
|
Protected Member Functions |
|
uint32_t | init_tables_to_write_lock (RDM_TABLE_ID *tables) |
IDs 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... |
|
Static Protected Member Functions |
|
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... |
|
Friends |
|
template<class ANY_NEXT > | |
class | RDM::DB::transaction |
template<class ANY_NEXT_1 , class ANY_NEXT_2 > | |
class | split |
template<uint32_t ANY_N, class ANY_RANGE_T , class ANY_NEXT > | |
class | collect |
template<uint32_t ANY_N, class ANY_RANGE_T , class ANY_INDATA_T , class ANY_NEXT > | |
class | fft |
template<uint32_t ANY_N, class ANY_AGGREGATE_T , class ANY_AGG_ELEMENT_T , class ANY_NEXT > | |
class | mean |
template<class ANY_RATIO , class ANY_NEXT > | |
class | scale |
template<uint32_t ANY_N, class ANY_STATS_T , class ANY_NEXT > | |
class | stats |
template<uint32_t ANY_N, class ANY_NEXT > | |
class | downsample |
template<class ANY_NEXT > | |
class | custom |
Detailed Description
Template Class for ignoring.
Class for ignoring what is received. This class may be at the end of a chain of template classes and is only useful as a temporary replacement for something else to be added later or where certain computations are being profiled without persisting the result.
This class can also be used for user-defined customization similar to custom, except that here we do not have a next class. Where customization is needed, create a subclass and implement the relevant methods there.
- Examples
- time_series_stats.cpp.
Member Function Documentation
flush_range()
|
inline |
Flush this object.
Calling this method does not do anything here.
- Return values
-
sOKAY Normal, successful return.
- Parameters
-
threshold [IN] Only flush objects where at least this many elements have been collected transactional [IN] Is the flush required to be transactional
References sOKAY.
flush_stats()
|
inline |
Flush this object.
Calling this method does not do anything here.
- Return values
-
sOKAY Normal, successful return.
- Parameters
-
threshold [IN] Only flush objects where at least this many elements have been collected transactional [IN] Is the flush required to be transactional
References sOKAY.
flush_value()
|
inline |
Flush this object.
Calling this method does not do anything here.
- Return values
-
sOKAY Normal, successful return.
- Parameters
-
threshold [IN] Only flush objects where at least this many elements have been collected transactional [IN] Is the flush required to be transactional
References sOKAY.
init()
|
inline |
Initialize this object.
Call this method before sending it any data values, ranges, or statistics. If you do not call it, the methods in this class will not complain as they always ignore everything and return sOKAY.
- Return values
-
sOKAY Normal, successful return.
- Parameters
-
db [IN] Ignore this database here. Parameter is only needed for interface compliance
- Examples
- time_series_stats.cpp.
References sOKAY.
init_tables_to_read_lock()
|
inlineprotected |
init_tables_to_write_lock()
|
inlineprotected |
number_of_tables_to_read_lock()
|
inlinestaticconstexprprotected |
number_of_tables_to_write_lock()
|
inlinestaticconstexprprotected |
put_range()
|
inline |
Template method for receiving ranges.
Receive one range and ignore it.
- Template Parameters
-
SOURCE_RANGE_T The actual type of the range received.
- Return values
-
sOKAY Normal, successful return.
- Parameters
-
[in] source_range The source range sent to this class transactional [IN] Is the put required to be transactional
References sOKAY.
put_stats()
|
inline |
Template method for receiving statistics.
Receive one statistic and ignore it.
- Template Parameters
-
SOURCE_STATS_T The actual type of the statistic received.
- Return values
-
sOKAY Normal, successful return.
- Parameters
-
[in] source_stats The source statistics sent to this class transactional [IN] Is the put required to be transactional
References sOKAY.
put_value()
|
inline |
Template method for receiving a data value.
Receive one data value and ignore it.
- Template Parameters
-
SOURCE_VALUE_T The actual type of the source values received.
- Return values
-
sOKAY Normal, successful return.
- Parameters
-
[in] source_value The source value sent to this class transactional [IN] Is the put required to be transactional
References sOKAY.
reset()
|
inline |
unflush()
|
inlineprotected |
unput()
|
inlineprotected |
Friends And Related Function Documentation
collect
|
friend |
custom
|
friend |
downsample
|
friend |
fft
|
friend |
mean
|
friend |
RDM::DB::transaction
|
friend |
scale
|
friend |
split
|
friend |
stats
|
friend |
The documentation for this class was generated from the following file: