EPICS ARCHIVER V4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups
Public Member Functions | List of all members
SampleMechanismEA3 Class Reference
Inheritance diagram for SampleMechanismEA3:
SampleMechanism ProcessVariableListener Guardable Named ProcessVariableStateListener ProcessVariableValueListener SampleMechanismGetEA3 SampleMechanismMonitoredEA3 SampleMechanismMonitoredGetEA3

Public Member Functions

 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 pvConnected (ProcessVariable &pv, const epicsTime &when)
 ProcessVariableStateListener. 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 std::string getInfo (Guard &guard)
 
virtual void start (Guard &guard)
 Start the sample mechanism. More...
 
virtual void stop (Guard &guard)
 Stop sampling. More...
 
virtual void addToFUX (Guard &guard, FUX::Element *doc)
 Append this sample mechanism to a FUX document. 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.
 

Member Function Documentation

size_t SampleMechanismEA3::getSampleCount ( Guard guard) const
inline
Returns
Returns the number of samples in the circular buffer.
virtual void SampleMechanismEA3::pvConnected ( ProcessVariable pv,
const epicsTime &  when 
)
virtual

ProcessVariableStateListener.

Base implementation allocates circular buffer

Implements SampleMechanism.

Reimplemented in SampleMechanismMonitoredGetEA3, and SampleMechanismMonitoredEA3.

virtual void SampleMechanismEA3::pvValue ( ProcessVariable pv,
const RawValue::Data data 
)
virtual

ProcessVariableValueListener.

Base implementation adds data to buffer. In addition, the initial value after a new connection is also logged with the host time stamp. For PVs that never change, this helps because the original time stamp might be before the last 'disconnect', so this gives us an idea of when the PV connected.

Implements SampleMechanism.

virtual unsigned long SampleMechanismEA3::write ( Guard guard,
Index index 
)
virtual

Write current buffer to index.

Returns
Returns number of samples written.

Implements SampleMechanism.


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