ossimConnectableObject.h

Go to the documentation of this file.

//*******************************************************************
// Copyright (C) 2000 ImageLinks Inc. 
//
// License:  See top level LICENSE.txt file.
//
// Author: Garrett Potts
//
// Description:
// 
// Contains class declaration for ossimConnectableObject the base class for
// all connectable objects.
//
//*************************************************************************
// $Id$

#ifndef ossimConnectableObject_HEADER
#define ossimConnectableObject_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimObject.h>
#include <ossim/base/ossimId.h>
#include <ossim/base/ossimListenerManager.h>
#include <ossim/base/ossimPropertyInterface.h>
#include <ossim/base/ossimRefPtr.h>
#include <vector>

class ossimVisitor;
class ossimConnectableContainer;

class  OSSIMDLLEXPORT  ossimConnectableObject : public ossimObject,
                                                public ossimListenerManager,
                                                public ossimPropertyInterface
{
public:
   typedef std::vector<ossimRefPtr<ossimConnectableObject> > ConnectableObjectList;
   enum ossimConnectableObjectDirectionType
   {
      CONNECTABLE_DIRECTION_NONE   = 0,
      CONNECTABLE_DIRECTION_INPUT  = 1,
      CONNECTABLE_DIRECTION_OUTPUT = 2
   };
   ossimConnectableObject(ossimObject* owner=0);
   ossimConnectableObject(ossimObject* owner,
                          ossim_int32 inputListSize,
                          ossim_int32 outputListSize,
                          bool inputListIsFixedFlag=true,
                          bool outputListIsFixedFlag=true);

   virtual ~ossimConnectableObject();
   void setId(const ossimId& id);

   const ossimId& getId()const;
   
   const ossimObject* getOwner() const;

   virtual void changeOwner(ossimObject* owner);

   virtual void setDescription(const ossimString& description);
   virtual ossimString getDescription()const;
   
   virtual bool isConnected(
      ossimConnectableObjectDirectionType direction = CONNECTABLE_DIRECTION_INPUT)const;


   OSSIM_DEPRECATE_METHOD(virtual ossimConnectableObject* findConnectableObject(
                             const ossimId& id));

   OSSIM_DEPRECATE_METHOD(virtual ossimConnectableObject* findObjectOfType(
                             RTTItypeid typeId,
                             ossimConnectableObjectDirectionType directionType,
                             bool recurse = true));

   OSSIM_DEPRECATE_METHOD(virtual ossimConnectableObject* findObjectOfType(
                             const ossimString& obj,
                             ossimConnectableObjectDirectionType directionType,
                             bool recurse = true));
   
   OSSIM_DEPRECATE_METHOD(virtual ossimConnectableObject* findInputObjectOfType(
                             const ossimString& className));
   
   virtual ossim_int32 findInputIndex(const ossimConnectableObject* object);

   virtual ossim_int32 findInputIndex(const ossimId& id);

   virtual ossim_int32 findOutputIndex(const ossimConnectableObject* object);

   virtual ossim_int32 findOutputIndex(const ossimId& id);
   
   virtual ossim_int32 getMyInputIndexToConnectTo(
      ossimConnectableObject* object)const;
   

   virtual ossim_int32 getMyOutputIndexToConnectTo(
      ossimConnectableObject* object)const;
   
   virtual bool canConnectMyInputTo(
      ossim_int32 myInputIndex, const ossimConnectableObject* object)const=0;
   
   virtual bool canConnectMyOutputTo(ossim_int32 myOutputIndex,
                                     const ossimConnectableObject* object)const;
   
   virtual void disconnect(ossimConnectableObject* object=0);

   virtual void disconnect(const ossimId& id);
   
   virtual ossimRefPtr<ossimConnectableObject> disconnectMyInput(
      ossim_int32 inputIndex,
      bool disconnectOutputFlag=true,
      bool createEventFlag = true);
   
   virtual void disconnectMyInput(ossimConnectableObject* input,
                                  bool disconnectOutputFlag=true,
                                  bool createEventFlag = true);
   virtual void disconnectMyInputs(
      ConnectableObjectList& inputList,
      bool disconnectOutputFlag=true,
      bool createEventFlag=true);
   
   virtual ossimRefPtr<ossimConnectableObject> disconnectMyOutput(
      ossim_int32 outputIndex,
      bool disconnectInputFlag=true,
      bool createEventFlag = true);
   
   virtual void disconnectMyOutput(ossimConnectableObject* output,
                                   bool disconnectInputFlag=true,
                                   bool createEventFlag=true);

   virtual void disconnectMyOutputs(
      ConnectableObjectList& outputList,
      bool disconnectOutputFlag=true,
      bool createEventFlag=true);
   
   virtual void disconnectAllInputs();

   virtual void disconnectAllOutputs();

   virtual ossim_int32 connectMyInputTo(ossimConnectableObject* inputObject,
                                        bool makeOutputConnection=true,
                                        bool createEventFlag=true);

   virtual ossim_int32 connectMyInputTo(ossim_int32 inputIndex,
                                        ossimConnectableObject* inputObject,
                                        bool makeOutputConnection=true,
                                        bool createEventFlag=true);
   
   virtual bool connectMyInputTo(
      ConnectableObjectList& inputList,
      bool makeOutputConnection=true,
      bool createEventFlag = true);   

   virtual ossim_int32 connectMyOutputTo(ossimConnectableObject* outputObject,
                                         bool makeInputConnection=true,
                                         bool createEventFlag=true);
   
   virtual bool connectMyOutputTo(
      ConnectableObjectList& outputList,
      bool makeInputConnection=true,
      bool createEventFlag=true);
   
   virtual bool connectInputList(
      ConnectableObjectList& inputList);
   
   virtual bool connectOutputList(
      ConnectableObjectList& outputList);
   
   virtual ossim_uint32 getNumberOfInputs()const;

   virtual ossim_uint32 getNumberOfOutputs()const;
   
   ossimConnectableObject* getInput(ossim_uint32 index=0);   

   const ossimConnectableObject* getInput(ossim_uint32 index=0)const;

   ossimConnectableObject* getOutput(ossim_uint32 index=0);

   const ossimConnectableObject* getOutput(ossim_uint32 index=0)const;
   
   virtual void setNumberOfInputs(ossim_int32 numberOfInputs);

   virtual bool getInputListIsFixedFlag()const;
   
   virtual bool getOutputListIsFixedFlag()const;

   virtual void setNumberOfOutputs(ossim_int32 numberOfInputs);
   
   const ConnectableObjectList& getInputList()const;

   const ConnectableObjectList& getOutputList()const;

   ConnectableObjectList& getInputList();

   ConnectableObjectList& getOutputList();

    OSSIM_DEPRECATE_METHOD(virtual void findAllObjectsOfType(
                              ConnectableObjectList& result,
                              const RTTItypeid& typeInfo, bool recurse=true) );
    
   OSSIM_DEPRECATE_METHOD(virtual void findAllObjectsOfType(
                             ConnectableObjectList& result,
                             const ossimString& className,
                             bool recurse=true));

#if 0 /* Deprecated code. Left here until thoroughly debugged. (drb) */

   OSSIM_DEPRECATE_METHOD(virtual void findAllInputsOfType(
      ConnectableObjectList& result,
      const RTTItypeid& typeInfo,
      bool propagateToInputs=true,
      bool recurseChildren=false));
   
   OSSIM_DEPRECATE_METHOD(virtual void findAllInputsOfType(
                             ConnectableObjectList& result,
                             const ossimString& className,
                             bool propagateToInputs=true,
                             bool recurseChildren=false));
#endif  /* deprecated code. (drb) */

   virtual void propagateEventToOutputs(ossimEvent& event);
   virtual void propagateEventToInputs(ossimEvent& event);

   /* ------------------- PROPERTY INTERFACE -------------------- */
   virtual void setProperty(ossimRefPtr<ossimProperty> property);
   virtual void setProperty(const ossimString& name, const ossimString& value);
   virtual ossimRefPtr<ossimProperty> getProperty(const ossimString& name)const;
   virtual void getPropertyNames(std::vector<ossimString>& propertyNames)const;
   /* ------------------ PROPERTY INTERFACE END ------------------- */

   
   virtual bool loadState(const ossimKeywordlist& kwl,
                          const char* prefix = 0);
   
   virtual bool saveState(ossimKeywordlist& kwl,
                          const char* prefix = 0)const;

   virtual ossim_uint32 saveStateOfAllInputs(ossimKeywordlist& kwl,
                                             bool saveThisStateFlag=true,
                                             ossim_uint32 objectIndex=1,
                                             const char* prefix=0) const;

   virtual bool fillContainer(ossimConnectableContainer& container);

   bool moveInputUp(const ossimId& id);

   bool moveInputDown(const ossimId& id);

   bool moveInputToTop(const ossimId& id);

   bool moveInputToBottom(const ossimId& id);
   
   virtual void accept(ossimVisitor& visitor);
   
protected:

   ossimConnectableObject* findObjectOfType(
      ConnectableObjectList* connectableList,
      ossimVisitor& visitor );
   
   ossimId      theId;
   ossimString  theDescription;
   ossimObject* theOwner;

   bool theInputListIsFixedFlag;

   bool theOutputListIsFixedFlag;
   
   ConnectableObjectList theInputObjectList;
   
   ConnectableObjectList theOutputObjectList;

private:
TYPE_DATA
};

#endif /* #ifndef ossimConnectableObject_HEADER */