EPICS ARCHIVER V4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups
Public Member Functions | List of all members
SampleMechanismMonitoredEA3 Class Reference

Monitored Sample Mechanism. More...

#include <SampleMechanismMonitoredEA3.h>

Inheritance diagram for SampleMechanismMonitoredEA3:
SampleMechanismEA3 SampleMechanism ProcessVariableListener Guardable Named ProcessVariableStateListener ProcessVariableValueListener

Public Member Functions

 SampleMechanismMonitoredEA3 (EngineConfig &config, ProcessVariableContext &ctx, const char *name, double period_estimate)
 Constructor.
 
virtual ~SampleMechanismMonitoredEA3 ()
 Destructor.
 
virtual std::string getInfo (Guard &guard)
 
virtual void addToFUX (Guard &guard, FUX::Element *doc)
 Append this sample mechanism to a FUX document. More...
 
virtual void pvConnected (ProcessVariable &pv, const epicsTime &when)
 ProcessVariableStateListener. More...
 
- Public Member Functions inherited from SampleMechanismEA3
 SampleMechanismEA3 (const EngineConfig &config, ProcessVariableContext &ctx, const char *name, double period, ProcessVariableListener *disable_filt_listener)
 Constructor.
 
virtual ~SampleMechanismEA3 ()
 Destructor.
 
virtual unsigned long write (Guard &guard, Index &index)
 Write current buffer to index. More...
 
virtual void pvValue (ProcessVariable &pv, const RawValue::Data *data)
 ProcessVariableValueListener. More...
 
size_t getSampleCount (Guard &guard) const
 
- Public Member Functions inherited from SampleMechanism
 SampleMechanism (const EngineConfig &config, ProcessVariableContext &ctx, const char *name, double period, ProcessVariableListener *disable_filt_listener)
 Construct mechanism for given period. More...
 
virtual void start (Guard &guard)
 Start the sample mechanism. More...
 
virtual void stop (Guard &guard)
 Stop sampling. More...
 
void pvDisconnected (ProcessVariable &pv, const epicsTime &when)
 ProcessVariableStateListener. More...
 
virtual OrderedMutexgetMutex ()
 
virtual const std::string & getName () const
 Gets the ProcessVariable name. More...
 
bool isRunning (Guard &guard)
 
ProcessVariable::State getPVState ()
 
void disable (const epicsTime &when)
 Temporarily disable sampling. More...
 
void enable (const epicsTime &when)
 Re-enable sampling. More...
 
void addStateListener (ProcessVariableStateListener *listener)
 Add a listener to the underlying PV. More...
 
void removeStateListener (ProcessVariableStateListener *listener)
 Remove a listener from the underlying PV. More...
 
void addValueListener (ProcessVariableValueListener *listener)
 Add a listener to the underlying PV. More...
 
void removeValueListener (ProcessVariableValueListener *listener)
 Remove a listener from the underlying PV. More...
 
- Public Member Functions inherited from ProcessVariableStateListener
virtual ~ProcessVariableStateListener ()
 Constructor.
 

Detailed Description

Monitored Sample Mechanism.

Every received sample is stored.

Requires a period estimate in order to allocate a buffer for the values until they are written to storage.

The data flows as follows:

  1. ProcessVariable (subscribed)
  2. DisableFilter
  3. TimeFilter
  4. SampleMechanismMonitored
  5. base SampleMechanism

Member Function Documentation

virtual void SampleMechanismMonitoredEA3::addToFUX ( Guard guard,
FUX::Element doc 
)
virtual

Append this sample mechanism to a FUX document.

Reimplemented from SampleMechanism.

virtual std::string SampleMechanismMonitoredEA3::getInfo ( Guard guard)
virtual
Returns
Returns a description of mechanism and current state.

Reimplemented from SampleMechanism.

virtual void SampleMechanismMonitoredEA3::pvConnected ( ProcessVariable pv,
const epicsTime &  when 
)
virtual

ProcessVariableStateListener.

Base implementation allocates circular buffer

Reimplemented from SampleMechanismEA3.


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