Abstract interface to sources of TimeSeries data. More...

#include <Source.h>

Inheritance diagram for dsp::Source:

Public Member Functions
	Source (const char *name)
	Constructor.

virtual	~Source ()
	Destructor.

virtual Source *	clone () const =0
	Return a default constructed clone of self.

Operation::Function	get_function () const override
	Each Source object is classified as a Producer Operation.

virtual const Observation *	get_info () const =0
	Get the const Observation attributes that describe the source.

virtual Observation *	get_info ()=0
	Get the mutable Observation attributes that describe the source.

virtual void	set_output (TimeSeries *data)=0
	Set the TimeSeries object used to store output data.

virtual TimeSeries *	get_output ()=0
	Get the TimeSeries object used to store output data.

virtual bool	has_output () const =0
	Return true if this object has a TimeSeries object to store output data.

virtual uint64_t	get_total_samples () const =0
	Get the total number of time samples available (return 0 if unknown)

virtual uint64_t	get_current_sample () const =0
	Get the current time sample offset from the start of data.

virtual double	get_current_time () const =0
	Get the current time offset from the start of data in seconds.

virtual void	seek_time (double second)=0
	Seek to the specified time in seconds. More...

virtual void	set_total_time (double second)=0
	Truncate the time series at the specified second. More...

virtual bool	end_of_data () const =0
	Return true when the end of data has been reached.

virtual void	restart ()=0
	Return to the start of data, if possible.

virtual void	set_block_size (uint64_t)=0
	Set the desired number of time samples per segment output by the source.

virtual uint64_t	get_block_size () const =0
	Get the number of time samples per segment output by the source. More...

virtual void	set_overlap (uint64_t)=0
	Set the number of time samples by which segments of output TimeSeries data overlap.

virtual uint64_t	get_overlap () const =0
	Set the number of time samples by which segments of output TimeSeries data overlap.

virtual bool	get_order_supported (TimeSeries::Order) const =0
	Return true if the source supports the specified output order.

virtual void	set_output_order (TimeSeries::Order)=0
	Set the order of the dimensions in the output TimeSeries.

virtual bool	get_device_supported (Memory *) const =0
	Return true if the source can operate on the specified device.

virtual void	set_device (Memory *)=0
	Set the device on which the source will operate.

virtual void	share (Source *)=0
	Share any resources that can/should be shared between threads.

virtual void	set_context (ThreadContext *context)=0
	Set the mutual exclusion and condition used to protect shared resources.

Public Member Functions inherited from dsp::Operation
	Operation (const char *name)
	All sub-classes must specify a unique name. More...

	Operation (const Operation &)
	Copy constructor.

virtual	~Operation ()
	Virtual destructor.

virtual bool	operate ()
	Call this method to operate on data Returns false on failure. More...

virtual void	prepare ()
	Prepare for data operations. More...

virtual void	reserve ()
	Reserve the maximum amount of memory required. More...

virtual void	add_extensions (Extensions *)
	Add any extensions.

virtual void	combine (const Operation *)
	Combine accumulated results with another operation. More...

virtual void	report () const
	Report operation statistics.

virtual void	reset ()
	Reset accumulated results to intial values. More...

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. More...

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

int	get_id ()
	Inquire the unique instantiation id.

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.

bool	scratch_was_set () const

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

virtual uint64_t	bytes_scratch () const
	The number of bytes of scratch space used by the operation. More...

Public Member Functions inherited from OwnStream
	OwnStream (const OwnStream &)

const OwnStream &	operator= (const OwnStream &)

virtual void	set_cout (std::ostream &) const

virtual void	set_cerr (std::ostream &) const

Public Member Functions inherited from Reference::Able
	Able (const Able &)

Able &	operator= (const Able &)

unsigned	get_reference_count () const

Public Member Functions inherited from Reference::HeapTracked
	HeapTracked (const HeapTracked &)

HeapTracked &	operator= (const HeapTracked &)

bool	__is_on_heap () const

Additional Inherited Members
Public Types inherited from dsp::Operation
enum	Function { Producer, Procedural, Structural }
	The function of the operator. More...

Static Public Member Functions inherited from Reference::Able
static size_t	get_instance_count ()

Static Public Member Functions inherited from Reference::HeapTracked
static void *	operator new (size_t size, void *ptr=0)

static void	operator delete (void location, void ptr)

static void	operator delete (void *location)

static size_t	get_heap_queue_size ()

Static Public Attributes inherited from dsp::Operation
static bool	record_time = false
	Global flag enables stopwatch to record the time spent operating. More...

static bool	report_time = true
	Global flag enables report of time spent in operation on descruction. More...

static bool	verbose = false
	Global verbosity flag.

static int	operation_status = 0
	Operations can set this to non-zero in operation() if they fail.

static bool	check_state = true
	Operations should perform internal consistency checks.

static int	instantiation_count = 0
	Counts how many Operation instantiations there have been Used for setting the unique instantiation ID. More...

Protected Member Functions inherited from dsp::Operation
virtual bool	can_operate ()
	Return false if the operation doesn't have enough data to proceed.

virtual void	operation ()=0
	Perform operation on data. Defined by derived classes.

virtual void	set_name (const std::string &_name)
	Set the name!

int	timers_index (const std::string &op_name)
	Returns the index in the 'timers' array of a particular timer.

Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const

void	__dereference (bool auto_delete=true) const

Protected Attributes inherited from dsp::Operation
Scratch *	scratch
	Shared scratch space, if needed.

bool	set_scratch_called

std::string	name
	Operation name.

uint64_t	discarded_weights
	Number of time sample weights encountered that are flagged invalid.

uint64_t	total_weights
	Total number of time sample weights encountered.

RealTimer	optime
	Stop watch records the amount of time spent performing this operation.

int	id
	Unique instantiation id.

bool	prepared
	Set true when preparation optimizations are completed.