pvSupport.h

/**
 * Copyright - See the COPYRIGHT that is included with this distribution.
 * EPICS pvData is distributed subject to a Software License Agreement found
 * in file LICENSE that is included with this distribution.
 */
/**
 * @author mrk
 * @date 2019.06.01
 */
#ifndef PVSUPPORT_H
#define PVSUPPORT_H

#include <list>
#include <map>

#include <pv/pvData.h>
#include <pv/pvTimeStamp.h>
#include <pv/rpcService.h>
#include <pv/pvStructureCopy.h>

#include <shareLib.h>

namespace epics { namespace pvDatabase {

class PVSupport;
typedef std::tr1::shared_ptr<PVSupport> PVSupportPtr;

/**
 * @brief Base interface for a PVSupport.
 *
 */
class epicsShareClass PVSupport
{
public:
    POINTER_DEFINITIONS(PVSupport);
    /**
     * The Destructor.
     */
    virtual ~PVSupport(){}
    /**
     * @brief Required initialization method.
     *
     * Implementation classes must define an init() method that must be
     * explicitly called by PVRecord classes that use them to provide
     * references to the specific fields to be supported. Different support
     * will may different fields, so a virtual method cannot be defined in
     * this base class to support them, hence this method always fails.
     *
     * @return <b>true</b> for success and <b>false</b> for failure.
     */
    bool init() {return false;}
    /**
     *  @brief Optional method for derived class.
     *
     * It is called before record is added to database.
     */
    virtual void start() {}
    /**
     * @brief Virtual method for derived class.
     *
     * Called when record is processed.
     *  It is the method that implements support.
     *  It is called each time the record is processed.
     *
     * @return Returns true is any fields were modified; otherwise false.
     */
    virtual bool process() = 0;
    /**
     *  @brief Optional method for derived class.
     *
     */
    virtual void reset() {};
};

}}

#endif  /* PVSUPPORT_H */