redAcore/FunctionCore.h

/*
 * FunctionCore.h
 *
 *  Created on: 18 May 2016
 *      Author: wentzelc
 */

#ifndef REDACORE_FUNCTIONCORE_H_
#define REDACORE_FUNCTIONCORE_H_

// Standard C/C++ Libraries
#include <string.h>

// redA Libraries
#include "LogCore.h"
#include "DataTreeCore.h"

//---------------------------------------------------------------------------

// Preview
typedef struct SChannel         TChannel;
typedef struct SChannelLink     TChannelLink;

class CFunctionCore;

//---------------------------------------------------------------------------

struct SChannel
{
    char            * Name          = NULL;
    char            * Ref           = NULL;

    TChannelLink    * FirstLink     = NULL;     // List of channels from which input can be received

    bool            InputEnabled    = NULL;     // Can Channel receive input
    bool            OutputEnabled   = NULL;     // Can channel receive output

    bool            Ready           = false;    // Channel ready to receive input

    TChannel        * Next          = NULL;
};
//---------------------------------------------------------------------------

struct SChannelLink
{
    CFunctionCore   * Function      = NULL;
    char            * Name          = NULL;
    char            * Ref           = NULL;

    SChannelLink    * Next          = NULL;
};
//---------------------------------------------------------------------------

// Function Constructor
#define TYPE_FUNCTION "Function"
//CFunctionCore * NewFunctionCore( const char * Name );

//---------------------------------------------------------------------------

class CFunctionCore
{
protected:
    // Function Definition
    const char  * Type              = NULL;
    char        * Name              = NULL;
    bool        WaitToTerminate     = false;

    // JSON Config
    CDataMember * Config            = NULL;

    // Channels
    TChannel    * FirstChannel      = NULL;

    // Logging
    CLogCore    * Log               = NULL;
    EDebugLevel LogLevel            = dlNone;
    int         LogOutput           = loNone;

    // Manage Channel
    inline TChannel *  GetChannel( const char * pName ) {
        if (!pName) return NULL;
        TChannel * Channel = FirstChannel;
        while (Channel && strcmp( pName, Channel->Name ))
            Channel = Channel->Next;
        return Channel;
    }

    // Data Input/Output
    virtual int  Output( const TChannel * Channel, const char * TargetRef, const bool SourceRef, const char * Data, int Len, int OutputFormat = loNone );

public:
    // Life cycle
    CFunctionCore( const char * pName, const char * pType = TYPE_FUNCTION );
    virtual ~CFunctionCore();

    // Load Configuration
    virtual bool  Init( CDataMember * FunctionConfig );
    virtual bool  InitChannelLinks( CDataMember *LinkConfig );

    // Set Parameters Manually
    bool  SetLogParam( EDebugLevel pDebugLevel, int pOutputDisplay );
    bool  SetLogLevel( EDebugLevel pDebugLevel );

    // Miscellaneous
    inline const char * GetName()   { return Name; };
    inline const char * GetType()   { return Type; };

    // Manage Channels
    virtual TChannel *  AddChannel( const char * ChannelName, const bool pInputEnable = true, const bool pOutputEnabled = true );
    inline bool        SetChannelOutEnable( const char * ChannelName, const bool pOutputEnable ) {
        TChannel * Channel = GetChannel( ChannelName );
        if (!Channel) return false;
        Channel->OutputEnabled = pOutputEnable;
        return true;
    }
    inline bool        SetChannelInEnable( const char * ChannelName, const bool pInputEnable ) {
        TChannel * Channel = GetChannel( ChannelName );
        if (!Channel) return false;
        Channel->InputEnabled = pInputEnable;
        return true;
    }
    inline bool         isInputEnabled( const char * ChannelName ) {
        TChannel * Channel = GetChannel( ChannelName );
        return ((Channel)? Channel->InputEnabled : false);
    }
    inline bool         isOutputEnabled( const char * ChannelName ) {
        TChannel * Channel = GetChannel( ChannelName );
        return ((Channel)? Channel->OutputEnabled : false);
    }

    // Pushing Data Output -> Input
    virtual int Output( const char * ChannelName, const char * TargetRef, const bool SourceRef, const char * Data, int Len = -1 );
    virtual int Input( const char * ChannelName, const char * SourceRef, const char * Data, int Len = -1 );

    // Automated Data Input/Output
    virtual bool LinkChannel( const char * ChannelName, const char * LinkFunctionName, const char * LinkChannelName, bool Bidirectional );
    virtual bool Process() = 0;

    friend class CApplication;
};

//---------------------------------------------------------------------------

#endif /* REDACORE_FUNCTIONCORE_H_ */