TRChannelsDriver.h

Go to the documentation of this file.

/* This file is part of the Transient Recorder Framework.
 * It is subject to the license terms in the LICENSE.txt file found in the
 * top-level directory of this distribution and at
 * https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. No part
 * of the Transient Recorder Framework, including this file, may be copied,
 * modified, propagated, or distributed except according to the terms
 * contained in the LICENSE.txt file.
 */

#ifndef TRANSREC_BASE_CHANNELS_DRIVER_H
#define TRANSREC_BASE_CHANNELS_DRIVER_H

#include <stddef.h>

#include <string>

#include <asynNDArrayDriver.h>

#include "TRNonCopyable.h"

class TRBaseDriver;
class TRChannelsDriver;
class TRChannelDataSubmit;
class TRArrayCompletionCallback;

class TRChannelsDriverConfig {
    friend class TRChannelsDriver;
    
public:
    inline TRChannelsDriverConfig (TRBaseDriver &base_driver)
    : num_extra_addrs(0),
      num_asyn_params(0),
      base_driver(base_driver)
    {
    }
    
    int num_extra_addrs;
    
    int num_asyn_params;
    
    template <typename ParamType>
    inline TRChannelsDriverConfig & set (ParamType TRChannelsDriverConfig::*param, ParamType const &value)
    {
        this->*param = value;
        return *this;
    }
    
private:
    TRBaseDriver &base_driver;
};

class TRChannelsDriver : public asynNDArrayDriver,
    private TRNonCopyable
{
    friend class TRBaseDriver;
    friend class TRChannelDataSubmit;
    
private:
    // Enumeration of asyn parameters.
    enum Params {
        UPDATE_ARRAYS,
        NUM_CHANNEL_ASYN_PARAMS
    };
    
public:
    TRChannelsDriver (TRChannelsDriverConfig const &cfg);
    
    virtual ~TRChannelsDriver ();
    
private:
    // The follwing functions are for internal use by Transient Recorder framework.
    
    // Clear all arrays from pArrays (called during arming).
    void resetArrays ();
    
    // Allocate an NDArray for later submission.
    NDArray * allocateArray (NDDataType_t data_type, int num_samples);
    
    // Submit an NDArray to the port.
    void submitArray (NDArray *array, int channel, double sample_rate,
                      TRArrayCompletionCallback *compl_cb);
    
private:
    // Array of asyn parameter indices.
    int m_asyn_params[NUM_CHANNEL_ASYN_PARAMS];
};

#endif