Class dsp::Operation

class Operation : public OwnStream 

Defines the interface by which operations are performed on data.

This pure virtual base class defines the manner in which various digital signal processing routines are performed on baseband data

Public Types

enum Function

The function of the operator.

Values:

enumerator Producer

enumerator Procedural: operations that produce data

enumerator Structural

operations that process data

operations that don’t modify data

Public Functions

Operation(const char *name): All sub-classes must specify a unique name.

Operation(const Operation&): Copy constructor.

virtual ~Operation(): Virtual destructor.

virtual void operate()

Call this method to operate on data.

Throws exception on failure

virtual void prepare()

Prepare for data operations.

This method enables optimizations by some derived classes

virtual void reserve()

Reserve the maximum amount of memory required.

This avoids the need to reallocate and copy later

virtual void add_extensions(Extensions*): Add any extensions.

virtual void combine(const Operation*)

Combine accumulated results with another operation.

This method enables results from multiple threads to be combined

virtual void report() const: Report operation statistics.

virtual void reset(): Reset accumulated results to initial values.

virtual void reset_time() const

Reset accumulated wall time to zero.

Note that optime is mutable and this method is const so that it can be called on constant Operation instances; elapsed wall time is informational and not critical, and therefore not protected.

inline std::string get_name() const: Return the unique name of this operation.

double get_total_time() const: Return the total time spent on this Operation in seconds.

double get_elapsed_time() const: Get the time spent in the last invocation of operate().

virtual uint64_t get_total_weights() const: Return the total number of timesample weights encountered.

virtual uint64_t get_discarded_weights() const: Return the number of invalid timesample weights encountered.

inline int get_id(): Inquire the unique instantiation id.

inline virtual Function get_function() const: Get the function classification of this operation.

inline virtual double get_delay_time() const: Get the time delay of this operation, if any, in seconds.

virtual void set_scratch(Scratch*): Set the scratch space.

inline virtual uint64_t bytes_storage() const: The number of bytes of additional storage used by the operation.

inline virtual uint64_t bytes_scratch() const

The number of bytes of scratch space used by the operation.

Scratch space is temporary and can be shared.

inline virtual const PerformanceMetrics *get_performance_metrics(): Get the current performance metrics for the operation.

Public Members

PerformanceMetrics *performance_metrics = nullptr: Declaration of the performance metrics.

Public Static Attributes

static bool record_time: Global flag enables stopwatch to record the time spent operating.

static bool report_time: Global flag enables report of time spent in operation on destruction.

static bool verbose: Global verbosity flag.

static bool check_state: Operations should perform internal consistency checks.

static int instantiation_count: Counts how many Operation instantiations there have been Used for setting the unique instantiation ID

class PerformanceMetrics

a class that captures the performance metrics of operations.

Subclasses of