MpTopologyGraph.h

Go to the documentation of this file.

//  
// Copyright (C) 2006-2008 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2006-2008 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// $$

// Author: Dan Petrie <dpetrie AT SIPez DOT com>

#ifndef _MpTopologyGraph_h_
#define _MpTopologyGraph_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include <mp/MpFlowGraphBase.h>

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class MpResourceTopology;
class MpResourceFactory;

class MpTopologyGraph : public MpFlowGraphBase
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */


   MpTopologyGraph(int samplesPerFrame, 
                   int samplesPerSec,
                   MpResourceTopology& initialResourceTopology,
                   MpResourceFactory& resourceFactory,
                   OsMsgDispatcher *pNotifDispatcher = NULL);

   virtual ~MpTopologyGraph();


/* ============================ MANIPULATORS ============================== */


   OsStatus addResources(MpResourceTopology& incrementalTopology,
                         MpResourceFactory* resourceFactory,
                         int resourceInstanceId);
   OsStatus destroyResources(MpResourceTopology& resourceTopology,
                            int resourceInstanceId);
   virtual OsStatus processNextFrame();

   virtual OsStatus gainFocus();

   virtual OsStatus loseFocus();


/* ============================ ACCESSORS ================================= */


   MpFlowGraphBase::FlowGraphType getType();

   OsStatus lookupVirtualInput(const UtlString& virtualName,
                               int virtualPortIdx,
                               MpResource*& rpResource,
                               int &portIdx);
   OsStatus lookupVirtualOutput(const UtlString& virtualName,
                                int virtualPortIdx,
                                MpResource*& rpResource,
                                int &portIdx);
   OsStatus lookupInput(const UtlString& resourceName,
                        int portIdx,
                        MpResource*& pFoundResource,
                        int &foundPortIdx);
   OsStatus lookupOutput(const UtlString& resourceName,
                         int portIdx,
                         MpResource*& pFoundResource,
                         int &foundPortIdx);

/* ============================ INQUIRY =================================== */



/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

   virtual OsStatus postMessage(const MpFlowGraphMsg& message,
                                const OsTime& waitTime = OsTime::OS_INFINITY);


   virtual UtlBoolean handleMessage(OsMsg& message);

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

   MpResourceFactory* mpResourceFactory; 
   UtlHashMap         mVirtualInputs;    
   UtlHashMap         mVirtualOutputs;   

   int addTopologyResources(MpResourceTopology& resourceTopology,
                            MpResourceFactory& resourceFactory,
                            UtlHashBag& newResources,
                            UtlBoolean replaceNumInName = FALSE,
                            int resourceNum = -1);

   int addVirtualInputs(MpResourceTopology& resourceTopology,
                        UtlHashBag& newResources,
                        UtlBoolean replaceNumInName = FALSE,
                        int resourceNum = -1);

   int removeVirtualInputs(MpResourceTopology& resourceTopology,
                           UtlBoolean replaceNumInName,
                           int resourceNum);

   int addVirtualOutputs(MpResourceTopology& resourceTopology,
                         UtlHashBag& newResources,
                         UtlBoolean replaceNumInName = FALSE,
                         int resourceNum = -1);

   int removeVirtualOutputs(MpResourceTopology& resourceTopology,
                            UtlBoolean replaceNumInName,
                            int resourceNum);

   int linkTopologyResources(MpResourceTopology& resourceTopology,
                             UtlHashBag& newResources,
                             UtlBoolean replaceNumInName = FALSE,
                             int resourceNum = -1);


   MpTopologyGraph(const MpTopologyGraph& rMpTopologyGraph);


   MpTopologyGraph& operator=(const MpTopologyGraph& rhs);
};

/* ============================ INLINE METHODS ============================ */

#endif  // _MpTopologyGraph_h_