dsp::PhaseSeriesUnloader Class Reference

Base class for things that can unload PhaseSeries data somewhere. More...

#include <PhaseSeriesUnloader.h>

Inheritance diagram for dsp::PhaseSeriesUnloader:

Public Member Functions
	PhaseSeriesUnloader ()
	Constructor.
virtual	~PhaseSeriesUnloader ()
	Destructor.
virtual PhaseSeriesUnloader *	clone () const =0
	Clone operator.
virtual void	unload (const PhaseSeries *)=0
	Unload the PhaseSeries data.
virtual void	partial (const PhaseSeries *)
	Handle partially completed PhaseSeries data.
virtual PhaseSeries *	recycle ()
	After unload, a different PhaseSeries may be available for use.
virtual void	finish ()
	Perform any clean up tasks before completion.
virtual std::string	get_filename (const PhaseSeries *data) const
	Generate a filename using the current convention.
virtual void	set_convention (FilenameConvention *)
	Set the filename convention.
virtual FilenameConvention *	get_convention ()
virtual void	set_directory (const std::string &)
	Set the directory to which output data will be written. More...
virtual std::string	get_directory () const
virtual void	set_path_add_source (bool)
	place output files in a sub-directory named by source
virtual bool	get_path_add_source () const
virtual void	set_prefix (const std::string &)
	Set the prefix to be added to the front of filenames. More...
virtual std::string	get_prefix () const
virtual void	set_extension (const std::string &)
	Set the extension to be added to the end of filenames.
virtual std::string	get_extension () const
virtual void	set_minimum_integration_length (double seconds)=0
	Set the minimum integration length required to unload data.
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

Protected Attributes
Reference::To< FilenameConvention >	convention
	The filename convention.
std::string	directory
	The filename directory.
std::string	prefix
	The filename prefix.
std::string	extension
	The filename extension.
bool	path_add_source
	Put each output file in a sub-directory named by source.

Additional Inherited Members
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 ()
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Base class for things that can unload PhaseSeries data somewhere.

Member Function Documentation

set_directory()

void dsp::PhaseSeriesUnloader::set_directory ( const std::string &  p )

virtual

Set the directory to which output data will be written.

Set the path to which output data will be written.

set_prefix()

void dsp::PhaseSeriesUnloader::set_prefix ( const std::string &  p )

virtual

Set the prefix to be added to the front of filenames.

Set the prefix to which output data will be written.

Referenced by dsp::LoadToFold::prepare_archiver().

---

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

• PhaseSeriesUnloader.h
• PhaseSeriesUnloader.C