TRChannelDataSubmit.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_CHANNEL_DATA_SUBMIT_H
#define TRANSREC_CHANNEL_DATA_SUBMIT_H

#include <stddef.h>

#include <epicsTime.h>

#include <NDArray.h>

#include "TRNonCopyable.h"

class TRBaseDriver;
class TRArrayCompletionCallback;

class TRChannelDataSubmit :
    private TRNonCopyable
{
public:
    inline TRChannelDataSubmit ()
    : m_array(NULL)
    {
    }
    
    inline ~TRChannelDataSubmit ()
    {
        if (m_array != NULL) {
            m_array->release();
        }
    }
    
    bool allocateArray (TRBaseDriver &driver, int channel_num, NDDataType_t data_type,
                        int num_samples);
    
    inline void releaseArray ()
    {
        if (m_array != NULL) {
            m_array->release();
            m_array = NULL;
        }
    }
    
    inline void * data ()
    {
        return (m_array == NULL) ? NULL : m_array->pData;
    }
    
    void submit (TRBaseDriver &driver, int channel, int unique_id,
                 double timestamp, epicsTimeStamp epics_ts,
                 TRArrayCompletionCallback *compl_cb);
    
private:
    // The current NDArray, or NULL if none.
    NDArray *m_array;
};

class TRArrayCompletionCallback {
public:
    virtual bool completeArray (NDArray *array) = 0;
};

#endif