nidas  v1.2-1520
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
nidas::dynld::psql::PSQLProcessor Class Referenceabstract

#include <PSQLProcessor.h>

Inheritance diagram for nidas::dynld::psql::PSQLProcessor:
Inheritance graph
[legend]

Public Member Functions

 PSQLProcessor ()
 
 PSQLProcessor (const PSQLProcessor &x)
 Copy constructor. More...
 
virtual ~PSQLProcessor ()
 
PSQLProcessorclone () const
 
bool cloneOnConncetion () const
 
void connect (SampleInput *) throw (nidas::util::IOException)
 
void disconnect (SampleInput *) throw (nidas::util::IOException)
 
void connected (SampleOutput *orig, SampleOutput *output) throw ()
 
void disconnected (SampleOutput *output) throw ()
 
void setAveragePeriod (int val)
 Set average period, in milliseconds. More...
 
int getAveragePeriod () const
 Get average period, in milliseconds. More...
 
const std::set< const
SampleTag * > & 
getSampleTags () const
 Implementation of SampleSource::getSampleTags(). More...
 
virtual const std::string & getName () const
 
virtual void setName (const std::string &val)
 
virtual void setOptional (bool val)
 
virtual bool isOptional () const
 
virtual const DSMServicegetService () const
 What DSMService am I associated with? More...
 
virtual void setService (const DSMService *val)
 
virtual const DSMConfiggetDSMConfig () const
 What DSM am I associated with? More...
 
virtual void setDSMConfig (const DSMConfig *val)
 
dsm_sample_id_t getId () const
 
void setSampleId (int val)
 
unsigned int getSampleId () const
 
virtual void connectSource (SampleSource *)=0
 Connect a SampleSource to this SampleIOProcessor. More...
 
virtual void disconnectSource (SampleSource *)=0 throw ()
 Disconnect a SampleSource from this SampleIOProcessor. More...
 
SampleSourcegetRawSampleSource ()
 Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples. More...
 
SampleSourcegetProcessedSampleSource ()
 Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples. More...
 
virtual void addRequestedSampleTag (SampleTag *tag) throw (nidas::util::InvalidParameterException)
 Add a request for a SampleTag from this SampleIOProcessor. More...
 
virtual std::list< const
SampleTag * > 
getRequestedSampleTags () const
 
void addSampleTag (const SampleTag *tag) throw ()
 Implementation of SampleSource::addSampleTag(). More...
 
void removeSampleTag (const SampleTag *tag) throw ()
 
SampleTagIterator getSampleTagIterator () const
 Implementation of SampleSource::getSampleTagIterator(). More...
 
void addSampleClient (SampleClient *client) throw ()
 Implementation of SampleSource::addSampleClient(). More...
 
void removeSampleClient (SampleClient *client) throw ()
 Remove a SampleClient from this SampleSource. More...
 
void addSampleClientForTag (SampleClient *client, const SampleTag *tag) throw ()
 Add a Client for a given SampleTag. More...
 
void removeSampleClientForTag (SampleClient *client, const SampleTag *tag) throw ()
 Remove a SampleClient for a given SampleTag from this SampleSource. More...
 
int getClientCount () const throw ()
 How many SampleClients are currently in my list. More...
 
const SampleStatsgetSampleStats () const
 
virtual void addOutput (SampleOutput *val)
 Add an SampleOutput to this SampleIOProcessor. More...
 
virtual const std::list
< SampleOutput * > & 
getOutputs () const
 
void addParameter (Parameter *val) throw (nidas::util::InvalidParameterException)
 Add a parameter to this SampleIOProcessor, which will then own the pointer and will delete it in its destructor. More...
 
const std::list< const
Parameter * > & 
getParameters () const
 Get list of parameters. More...
 
void fromDOMElement (const xercesc::DOMElement *node) throw (nidas::util::InvalidParameterException)
 Initialize myself from a xercesc::DOMElement. More...
 
virtual void printStatus (std::ostream &, float, int &) throw ()
 
virtual void init (dsm_time_t) throw ()
 
virtual void flush ()=0 throw ()
 Request that this SampleSource flush it's samples. More...
 
virtual void connect (SampleOutput *output)=0 throw ()
 How SampleOutputs notify their SampleConnectionRequester that they are connected. More...
 
virtual void disconnect (SampleOutput *output)=0 throw ()
 How SampleOutputs notify their SampleConnectionRequester that they wish to be closed, likely do to an IOException. More...
 
virtual xercesc::DOMElement * toDOMParent (xercesc::DOMElement *parent, bool complete) const throw (xercesc::DOMException)
 Create a DOMElement and append it to the parent. More...
 
virtual xercesc::DOMElement * toDOMElement (xercesc::DOMElement *node, bool complete) const throw (xercesc::DOMException)
 Add my content into a DOMElement. More...
 

Static Public Member Functions

static const XMLCh * getNamespaceURI ()
 

Protected Member Functions

void removeRequestedSampleTag (SampleTag *tag)
 Allow subclasses to remove requested SampleTags. More...
 

Protected Attributes

SampleInputinput
 
SampleAverager averager
 
const nidas::core::Sitesite
 
SampleSourceSupport _source
 
nidas::util::Mutex _tagsMutex
 
std::list< SampleTag * > _requestedTags
 

Constructor & Destructor Documentation

PSQLProcessor::PSQLProcessor ( )

References MSECS_PER_SEC.

Referenced by clone().

PSQLProcessor::PSQLProcessor ( const PSQLProcessor x)

Copy constructor.

References nidas::core::SampleIOProcessor::setName().

PSQLProcessor::~PSQLProcessor ( )
virtual

Member Function Documentation

virtual void nidas::core::SampleIOProcessor::addOutput ( SampleOutput val)
inlinevirtualinherited

Add an SampleOutput to this SampleIOProcessor.

This is used to add a desired SampleOutput to this SampleIOProcessor. SampleIOProcessor will own the SampleOutput. Once a SampleSource has connected, then SampleIOProcessor is responsible for do SampleOutput::requestConnection, or SampleOutputRequestThread::addConnectRequest() on all these as-yet disconnected outputs.

References nidas::core::SampleIOProcessor::_origOutputs.

void SampleIOProcessor::addParameter ( Parameter val)
throw (nidas::util::InvalidParameterException
)
inherited

Add a parameter to this SampleIOProcessor, which will then own the pointer and will delete it in its destructor.

If a Parameter exists with the same name, it will be replaced with the new Parameter.

void SampleIOProcessor::addRequestedSampleTag ( SampleTag tag)
throw (nidas::util::InvalidParameterException
)
virtualinherited
void nidas::core::SampleIOProcessor::addSampleClient ( SampleClient client)
throw (
)
inlinevirtualinherited
void nidas::core::SampleIOProcessor::addSampleClientForTag ( SampleClient client,
const SampleTag tag 
)
throw (
)
inlinevirtualinherited
void SampleIOProcessor::addSampleTag ( const SampleTag tag)
throw (
)
virtualinherited
PSQLProcessor * PSQLProcessor::clone ( ) const

References PSQLProcessor().

bool nidas::dynld::psql::PSQLProcessor::cloneOnConncetion ( ) const
inline
virtual void nidas::core::SampleConnectionRequester::connect ( SampleOutput output)
throw (
)
pure virtualinherited
void PSQLProcessor::connect ( SampleInput newinput)
throw (nidas::util::IOException
)
void PSQLProcessor::connected ( SampleOutput orig,
SampleOutput output 
)
throw (
)
virtual void nidas::core::SampleIOProcessor::connectSource ( SampleSource )
pure virtualinherited
virtual void nidas::core::SampleConnectionRequester::disconnect ( SampleOutput output)
throw (
)
pure virtualinherited
void PSQLProcessor::disconnect ( SampleInput oldinput)
throw (nidas::util::IOException
)
void PSQLProcessor::disconnected ( SampleOutput output)
throw (
)
virtual void nidas::core::SampleIOProcessor::disconnectSource ( SampleSource )
throw (
)
pure virtualinherited
virtual void nidas::core::SampleSource::flush ( )
throw (
)
pure virtualinherited
void SampleIOProcessor::fromDOMElement ( const xercesc::DOMElement *  )
throw (nidas::util::InvalidParameterException
)
virtualinherited
int nidas::dynld::psql::PSQLProcessor::getAveragePeriod ( ) const
inline

Get average period, in milliseconds.

References averager.

int nidas::core::SampleIOProcessor::getClientCount ( ) const
throw (
)
inlinevirtualinherited
virtual const DSMConfig* nidas::core::SampleIOProcessor::getDSMConfig ( ) const
inlinevirtualinherited

What DSM am I associated with?

References nidas::core::SampleIOProcessor::_dsm.

dsm_sample_id_t nidas::core::SampleIOProcessor::getId ( ) const
inlineinherited
const std::string & SampleIOProcessor::getName ( ) const
virtualinherited
static const XMLCh* nidas::core::DOMable::getNamespaceURI ( )
inlinestaticinherited
virtual const std::list<SampleOutput*>& nidas::core::SampleIOProcessor::getOutputs ( ) const
inlinevirtualinherited
const std::list<const Parameter*>& nidas::core::SampleIOProcessor::getParameters ( ) const
inlineinherited

Get list of parameters.

References nidas::core::SampleIOProcessor::_constParameters.

SampleSource* nidas::core::SampleIOProcessor::getProcessedSampleSource ( )
inlinevirtualinherited

Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples.

SampleClients use this method to get a pointer to whatever sample source they are interested in. Derived classes can return NULL if they are not a SampleSource of processed samples.

Implements nidas::core::SampleSource.

References nidas::core::SampleIOProcessor::_source.

SampleSource* nidas::core::SampleIOProcessor::getRawSampleSource ( )
inlinevirtualinherited

Several objects in NIDAS can be both a SampleSource of raw Samples and processed Samples.

SampleClients use this method to get a pointer to whatever sample source they are interested in. Derived classes can return NULL if they are not a SampleSource of raw samples.

Implements nidas::core::SampleSource.

std::list< const SampleTag * > SampleIOProcessor::getRequestedSampleTags ( ) const
virtualinherited
unsigned int nidas::core::SampleIOProcessor::getSampleId ( ) const
inlineinherited
const SampleStats& nidas::core::SampleIOProcessor::getSampleStats ( ) const
inlinevirtualinherited
SampleTagIterator nidas::core::SampleIOProcessor::getSampleTagIterator ( ) const
inlinevirtualinherited
const std::set<const SampleTag*>& nidas::dynld::psql::PSQLProcessor::getSampleTags ( ) const
inlinevirtual
virtual const DSMService* nidas::core::SampleIOProcessor::getService ( ) const
inlinevirtualinherited

What DSMService am I associated with?

References nidas::core::SampleIOProcessor::_service.

virtual void nidas::core::SampleIOProcessor::init ( dsm_time_t  )
throw (
)
inlinevirtualinherited
virtual bool nidas::core::SampleIOProcessor::isOptional ( ) const
inlinevirtualinherited
virtual void nidas::core::SampleIOProcessor::printStatus ( std::ostream &  ,
float  ,
int &   
)
throw (
)
inlinevirtualinherited
void SampleIOProcessor::removeRequestedSampleTag ( SampleTag tag)
protectedinherited
void nidas::core::SampleIOProcessor::removeSampleClient ( SampleClient c)
throw (
)
inlinevirtualinherited
void nidas::core::SampleIOProcessor::removeSampleClientForTag ( SampleClient c,
const SampleTag  
)
throw (
)
inlinevirtualinherited

Remove a SampleClient for a given SampleTag from this SampleSource.

The pointer to the SampleClient must remain valid, until after it is removed.

Implements nidas::core::SampleSource.

Reimplemented in nidas::dynld::raf::SyncRecordGenerator.

References nidas::core::SampleIOProcessor::_source, and nidas::core::SampleSourceSupport::removeSampleClientForTag().

void SampleIOProcessor::removeSampleTag ( const SampleTag tag)
throw (
)
virtualinherited
void nidas::dynld::psql::PSQLProcessor::setAveragePeriod ( int  val)
inline

Set average period, in milliseconds.

References averager.

virtual void nidas::core::SampleIOProcessor::setDSMConfig ( const DSMConfig val)
inlinevirtualinherited
void SampleIOProcessor::setName ( const std::string &  val)
virtualinherited
virtual void nidas::core::SampleIOProcessor::setOptional ( bool  val)
inlinevirtualinherited
void nidas::core::SampleIOProcessor::setSampleId ( int  val)
inlineinherited
virtual void nidas::core::SampleIOProcessor::setService ( const DSMService val)
inlinevirtualinherited
xercesc::DOMElement * DOMable::toDOMElement ( xercesc::DOMElement *  node,
bool  complete 
) const
throw (xercesc::DOMException
)
virtualinherited
xercesc::DOMElement * DOMable::toDOMParent ( xercesc::DOMElement *  parent,
bool  complete 
) const
throw (xercesc::DOMException
)
virtualinherited

Member Data Documentation

std::list<SampleTag*> nidas::core::SampleIOProcessor::_requestedTags
protectedinherited
SampleSourceSupport nidas::core::SampleIOProcessor::_source
protectedinherited
nidas::util::Mutex nidas::core::SampleIOProcessor::_tagsMutex
mutableprotectedinherited
SampleAverager nidas::dynld::psql::PSQLProcessor::averager
protected
SampleInput* nidas::dynld::psql::PSQLProcessor::input
protected
const nidas::core::Site* nidas::dynld::psql::PSQLProcessor::site
protected

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