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

A filter to block samples while disabled. More...

#include <DisableFilter.h>

Inheritance diagram for DisableFilter:
ProcessVariableFilter Guardable ProcessVariableListener ProcessVariableStateListener ProcessVariableValueListener

Public Member Functions

 DisableFilter (ProcessVariableListener *listener)
 Construct a DisableFilter. More...
 
OrderedMutexgetMutex ()
 Allow concurrent access from ProcessVariableListener and enable/disable. More...
 
void disable (Guard &guard)
 Temporarily disable sampling. More...
 
void enable (Guard &guard, ProcessVariable &pv, const epicsTime &when)
 Re-enable sampling. More...
 
void pvConnected (ProcessVariable &pv, const epicsTime &when)
 React to connection, then pass on to listener. More...
 
void pvDisconnected (ProcessVariable &pv, const epicsTime &when)
 React to disconnect, then pass on to listener. More...
 
void pvValue (ProcessVariable &pv, const RawValue::Data *data)
 React to new value and filter it. More...
 
- Public Member Functions inherited from ProcessVariableFilter
 ProcessVariableFilter (ProcessVariableListener *listener)
 Create a PV filter which passes filtered events on to the provided listener.
 
- Public Member Functions inherited from ProcessVariableStateListener
virtual ~ProcessVariableStateListener ()
 Constructor.
 

Detailed Description

A filter to block samples while disabled.

Meant to be installed right after the ProcessVariable:

When the SampleMechanism is disabled, it instructs the DisableFilter to block all further samples. Actually, it keeps a copy of the most recent sample, so we start out with that last good sample when 'enabled' again, without having to wait for another new sample.

Constructor & Destructor Documentation

DisableFilter::DisableFilter ( ProcessVariableListener listener)

Construct a DisableFilter.

Member Function Documentation

void DisableFilter::disable ( Guard guard)

Temporarily disable sampling.

See Also
enable()
void DisableFilter::enable ( Guard guard,
ProcessVariable pv,
const epicsTime &  when 
)

Re-enable sampling.

See Also
disable()
OrderedMutex& DisableFilter::getMutex ( )
virtual

Allow concurrent access from ProcessVariableListener and enable/disable.

See Also
Guardable

Implements Guardable.

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

React to connection, then pass on to listener.

See Also
ProcessVariableListener

Reimplemented from ProcessVariableFilter.

void DisableFilter::pvDisconnected ( ProcessVariable pv,
const epicsTime &  when 
)
virtual

React to disconnect, then pass on to listener.

See Also
ProcessVariableListener

Reimplemented from ProcessVariableFilter.

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

React to new value and filter it.

Might invoke listener with the value, another value, or not at all.

See Also
ProcessVariableListener

Reimplemented from ProcessVariableFilter.


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