SourceObj.h

Go to the documentation of this file.

//------------------------------------------------------------------------
//
//   Joe Kniss
//     6-20-03
//                   ________    ____   ___ 
//                  |        \  /    | /  /
//                  +---+     \/     |/  /
//                  +--+|  |\    /|     < 
//                  |  ||  | \  / |  |\  \ 
//                  |      |  \/  |  | \  \ 
//                   \_____|      |__|  \__\
//                       Copyright  2003 
//                      Joe Michael Kniss
//                   <<< jmk@cs.utah.edu >>>
//               "All Your Base are Belong to Us"
//-------------------------------------------------------------------------


///SourceObj.h
///  simian core


#ifndef __SIMIAN_SOURCE_OBJ_DOT_H
#define __SIMIAN_SOURCE_OBJ_DOT_H

#include "AlgObj.h"

//////////////////////////////////////////////////////////////////////////
/// Source Object interface
/// A public interface to a Source object
//////////////////////////////////////////////////////////////////////////
class SourceObjIF : public AlgObj {
public:
   virtual ~SourceObjIF() {}
   virtual  unsigned int getNumOutputs() const = 0;

   ///////////////////////////////////////////
   ///@name Public Execute Interface
   ///@{

   /// Execute if anything changed, only if it needs to
   virtual void execute() = 0;
   /// Execute no matter what!
   virtual void force() = 0;

   ///@}
   ///////////////////////////////////////////

   ///////////////////////////////////////////
   ///@name Frame work interfaces NOT FOR GENERAL USE
   ///  users ignore these
   ///@{

   ///////////////////////////////////////
   /// request interface
   virtual bool request(DataObjSP d) = 0;

   ///@}
   ///////////////////////////////////////////


protected:
   /// protected default construction
   SourceObjIF() {}
   /// Filter constructor chain
   SourceObjIF(unsigned int numInputs)
      : AlgObj(numInputs) 
   {}

private:
   /// not used
   SourceObjIF(const SourceObjIF &so);
   /// not used
   SourceObjIF &operator=(const SourceObjIF &so);

};

typedef gutz::SmartPtr<SourceObjIF> SourceObjSP;

//////////////////////////////////////////////////////////////////////////
/// Source Object base class
//////////////////////////////////////////////////////////////////////////
class SourceObj : public SourceObjIF {
public:
   virtual ~SourceObj();
   unsigned int getNumOutputs() const {return _nOutputs;}

   ///////////////////////////////////////////
   /// Public Execute Interface
   /// Execute if anything changed
   /// DO NOT override this if you don't know
   /// what you are doing, use "execDef()"
   /// this will get called by these!
   virtual void execute();
   /// Execute no matter what!, unless you
   /// are going to get an update later
   virtual void force();

   ///////////////////////////////////////////
   /// Frame work interfaces, 
   ///        NOT FOR GENERAL USE
   /// ... ignore these
   ///////////////////////////////////////////

   ///////////////////////////////////////
   /// update interface
   virtual void setForwardModified();

   ///////////////////////////////////////
   /// request interface
   virtual bool request(DataObjSP d);

protected:
   /// protected default construction
   SourceObj();
   /// use this if you are a "true" source
   SourceObj(unsigned int numOutputs);
   /// use this if you are a "filter"
   SourceObj(unsigned int numInputs, unsigned int numOutputs);

   /// override this one to set the execution behavior
   /// of your source
   virtual void execDef()
   {derr("execDef(), not implemented! This should be over-ridden by a subclass!");}

   void updateOutputs();

   void       addOutput(DataObjSP d);
   void       delOutput(DataObjSP d);
   bool       isOutput(const DataObjSP d) const;
   void       setNumOutputs(int nOut);
   void       setOutputN(int outNum, DataObjSP d);
   /// returns raw pointer to facilitate easier dynamic_cast<YOUR_DATA_TYPE>
   DataObjIF *getOutputN(int outNum);

private:
   DataObjSP *_outputs;
   int        _nOutputs;
};



#endif

---

Send questions, comments, and bug reports to: