/**
 * @file NI6528.h
 * @brief Header file for class NI6528
 * @date 07/06/2018
 * @author Andre Neto
 *
 * @copyright Copyright 2015 F4E | European Joint Undertaking for ITER and
 * the Development of Fusion Energy ('Fusion for Energy').
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved
 * by the European Commission - subsequent versions of the EUPL (the "Licence")
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at: http://ec.europa.eu/idabc/eupl
 *
 * @warning Unless required by applicable law or agreed to in writing, 
 * software distributed under the Licence is distributed on an "AS IS"
 * basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the Licence permissions and limitations under the Licence.

 * @details This header file contains the declaration of the class NI6528
 * with all of its public, protected and private members. It may also include
 * definitions for inline methods which need to be visible to the compiler.
 */

#ifndef RANDOM_DATASOURCE_H_
#define RANDOM_DATASOURCE_H_

/*---------------------------------------------------------------------------*/
/*                        Standard header includes                           */
/*---------------------------------------------------------------------------*/
#include <pxi6528.h>

/*---------------------------------------------------------------------------*/
/*                        Project header includes                            */
/*---------------------------------------------------------------------------*/
#include "DataSourceI.h"

/*---------------------------------------------------------------------------*/
/*                           Class declaration                               */
/*---------------------------------------------------------------------------*/
/**
 * @brief NI6528 simplified data source implementation.
 *
 * The configuration syntax is (names and signal quantities are only given as an example):
 * +NI6528 = {
 *     Class = NI6528
 *     DeviceName = "/dev/pxi6528.0" //Mandatory
 *     Port = 0 //The port where to write
 *     Signals = {
 *         currentValue = {Type = uint8}
 *         bitmask = {Type = uint8}
 *         Value = {Type = uint8}
 *     }
 * }
 */
class NI6528: public MARTe::DataSourceI {
public:
    CLASS_REGISTER_DECLARATION()

    /**
     * @brief Constructor. NOOP.
     */
NI6528    ();

    /**
     * @brief Destructor. NOOP.
     */
    virtual ~NI6528();

    /**
     * @brief The configuration data detailed in the class description
     * @return true if all the compulsory parameters are set.
     */
    virtual bool Initialise(MARTe::StructuredDataI & data);

    /**
     * @brief Verifies that at most one signal has been set with the correct type (i.e. any integer).
     * @return true if the above conditions are met.
     */
    virtual bool SetConfiguredDatabase(MARTe::StructuredDataI & data);

    /**
     * @brief @see DataSourceI::Synchronise
     */
    virtual bool Synchronise();

    /**
     * @brief @see DataSourceI::AllocateMemory
     */
    virtual bool AllocateMemory();

    /**
     * @brief @see DataSourceI::GetSignalMemoryBuffer
     */
    virtual bool GetSignalMemoryBuffer(const MARTe::uint32 signalIdx, const MARTe::uint32 bufferIdx, void *&signalAddress);

    /**
     * @return "MemoryMapSynchronisedInputBroker"
     */
    virtual const MARTe::char8 *GetBrokerName(MARTe::StructuredDataI &data, const MARTe::SignalDirection direction);

    /**
     * @brief NOOP
     */
    virtual bool PrepareNextState(const MARTe::char8 * const currentStateName, const MARTe::char8 * const nextStateName);

private:
    /**
     * The previous value to write.
     */
    MARTe::uint8 previousValue;

    /**
     * The bitmask to write value. (new value) = (current value) || (bitmask) && (write value)
     */
    MARTe::uint8 bitmask;

    /**
     * The value to write.
     */
    MARTe::uint8 value;

    /**
     * The port number
     */
    MARTe::uint32 port;

    /**
     * The board file descriptor
     */
    pxi6528_device_t boardFileDescriptor;

    /**
     * The device name
     */
    MARTe::StreamString deviceName;
};

/*---------------------------------------------------------------------------*/
/*                        Inline method definitions                          */
/*---------------------------------------------------------------------------*/

#endif /* RANDOM_DATASOURCE_H_ */