moConnectors.h

Go to the documentation of this file.

/*******************************************************************************

                                moConnectors.h

  ****************************************************************************
  *                                                                          *
  *   This source is free software; you can redistribute it and/or modify    *
  *   it under the terms of the GNU General Public License as published by   *
  *   the Free Software Foundation; either version 2 of the License, or      *
  *  (at your option) any later version.                                    *
  *                                                                          *
  *   This code is distributed in the hope that it will be useful, but       *
  *   WITHOUT ANY WARRANTY; without even the implied warranty of             *
  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU      *
  *   General Public License for more details.                               *
  *                                                                          *
  *   A copy of the GNU General Public License is available on the World     *
  *   Wide Web at <http://www.gnu.org/copyleft/gpl.html>. You can also       *
  *   obtain it by writing to the Free Software Foundation,                  *
  *   Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.         *
  *                                                                          *
  ****************************************************************************

  Copyright(C) 2006 Fabricio Costa

  Authors:
  Fabricio Costa

*******************************************************************************/

#ifndef __MO_CONNECTORS_H__
#define __MO_CONNECTORS_H__

#include "moTypes.h"
#include "moText.h"
#include "moAbstract.h"
#include "moEventList.h"
#include "moConfig.h"
#include "moArray.h"


class LIBMOLDEO_API moConnector : public moAbstract {

    public:
        moConnector();

        virtual ~moConnector();

        virtual MOboolean Init();

        virtual MOboolean Finish();

        virtual MOboolean Init( moText p_ConnectorLabelName, MOint ConnectorId, moDataType p_datatype );

        virtual MOboolean Init( moText p_ConnectorLabelName, MOint ConnectorId, moText t_datatype );

        virtual MOboolean Init( moText p_ConnectorLabelName, MOint ConnectorId, moData* p_data );

        virtual MOboolean Init( moText p_ConnectorLabelName, MOint ConnectorId, moParam* p_param );

        virtual MOboolean Init( moText p_ConnectorLabelName, MOint ConnectorId, moParamType p_paramtype );


        MOint       GetConnectorId() const;

        moText      GetMoldeoLabelName() const;

        void        SetMoldeoLabelName( moText p_MoldeoLabelName );

        MOint       GetMoldeoId() const;

        void        SetMoldeoId( MOint p_moldeoid );

        virtual const moText&       GetConnectorLabelName() const;

        void        SetType( moDataType p_datatype );

        moDataType  GetType() const;

        void        SetData( moData*    p_data );

        moData*     GetData();
        moData*     GetInternalData();

        void        NewData();

        void        AddData( const moData& data );

        void        AddMessage( const moDataMessage& datamessage );

        moDataMessages&     GetMessages();


        MOboolean   Updated() const;

        void        Update( bool force = true );

    bool    IsIndependent() {
      return (m_pParam==NULL);
    }

    bool    IsParameterDependent() {
      return (m_pParam!=NULL);
    }

    protected:
        //Type and Data, it may be a pointer to the plugins data...:-D
        moData*             m_pData;

        moDataMessages     m_DataMessages;//historical data for streaming

        moParam     *m_pParam;

        MOint       m_MoldeoId;
        moText      m_MoldeoLabelName;
        MOint       m_ConnectorId;
        moText      m_ConnectorLabelName;

        MOboolean   m_bUpdated;

};

typedef moConnector* moConnectorPtr;
moDeclareExportedDynamicArray( moConnector*, moConnectors);


class LIBMOLDEO_API moConnection : public moAbstract  {

    public:
        moConnection();

        moConnection( moText p_DestinationMoldeoLabelName,  moText p_DestinationConnectorLabelName, MOint p_DestinationMoldeoId = -1, MOint p_DestinationConnectorId = -1 );

        virtual ~moConnection();

        MOint   GetDestinationMoldeoId();

        moText  GetDestinationMoldeoLabelName();

        MOint   GetDestinationConnectorId();

        moText  GetDestinationConnectorLabelName();

        void    SetDestinationMoldeoId( MOint p_DestinationMoldeoId );

        void    SetDestinationMoldeoLabelName( moText p_DestinationMoldeoLabelName );

        void    SetDestinationConnectorId( MOint p_DestinationConnectorId );

        void    SetDestinationConnectorLabelName( moText p_DestinationConnectorLabelName );
        /*
        virtual void Send();//ask to connector to receive data...
        virtual void OnSend();
        */
    protected:
        //SOURCE: not really necessary
        moText  m_SourceMoldeoLabelName;
        MOint   m_SourceMoldeoId;
        moText  m_SourceConnectorLabelName;
        MOint   m_SourceConnectorId;

        //DESTINATION
        moText  m_DestinationMoldeoLabelName;
        MOint   m_DestinationMoldeoId;
        moText  m_DestinationConnectorLabelName;
        MOint   m_DestinationConnectorId;

};

typedef moConnection* moConnectionPtr;
moDeclareExportedDynamicArray( moConnectionPtr, moConnections);



class LIBMOLDEO_API moInlet : public moConnector {

    public:
        moInlet();

        virtual ~moInlet();

        MOboolean Init( moText p_ConnectorLabelName, MOint ConnectorId, moParam* p_param );

};

moDeclareExportedDynamicArray( moInlet*, moInlets);



class LIBMOLDEO_API moOutlet : public moConnector {

    public:

        moOutlet();

        virtual ~moOutlet();

        virtual MOboolean Finish();

        virtual bool Connect( moInlet* p_connector );

        virtual void Disconnect( moInlet* p_connector );


        moConnections*  GetConnections();

    private:

        moConnections   m_Connections;

};


moDeclareExportedDynamicArray( moOutlet*, moOutlets);

#endif