arbeit
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

GenDataObj_base< T, P > Class Template Reference

#include <GenDataObj.h>

Inheritance diagram for GenDataObj_base< T, P >:

DataObj DataObjIF SimCore gutz::Counted SimBase List of all members.

Detailed Description

template<class T, class P>
class GenDataObj_base< T, P >

a base class for 2 kinds of generic data objects.

this is just the interface, see the classes below too. fills data vector with "nObs" Null objects, just place holders

Definition at line 35 of file GenDataObj.h.

Modified interface

bool isModified () const
void setModified (bool mod=true)

Serialization

TODO: should be pure virtual, SOON

virtual std::ostream & saveSelf (std::ostream &os)
 serialize

virtual std::istream & readSelf (std::istream &is)
 unserialize


Forward Modify interface, NOT FOR GENERAL USE.

framework interface.

bool isForwardModified ()
 is this thing aready marked for future update?


Text object-name

from SimBase

std::string getObjName ()
std::string getName ()
void setName (std::string name)
void setName (const char *name)

Debug prints

from SimBase: These print the object name with the error, mostly for convenience, but they are compiled to inline-no-op if you build in release mode

void derr (const char *when, const char *where=0) const
template<class T> void derr (const char *when, const char *where, const T stuff) const

Modification, AKA "changed"

from SimBase: id based, you can capture the current id for comparison later, if the id's don't match the class has been changed

virtual int getChangeID ()
virtual int getChangeID () const
virtual void setChanged ()

Public Types

typedef T DATA_TYPE
typedef P PTR_TYPE
typedef std::vector< PTR_TYPE > VEC_TYPE

Public Member Functions

virtual ~GenDataObj_base ()
 child classes are responsible for deleting their data

int size ()
 restate the size

PTR_TYPE getData (int i=0)
 safe way to get the data, zeroth by default

void setData (int i, PTR_TYPE d)
 safe way to set the data

void setData (PTR_TYPE d)
 set zeroth entry for convenience

void delData (int i=0)
 delete an entry

void pack ()
 pack vector

virtual void update_ ()
 Update Interface, propigates down the chain.

virtual bool request_ ()
 Request Interface, propigates down the chain.

virtual void setSource (gutz::SmartPtr< SourceObjIF > source)
 Source interface.

void addConsumer (gutz::SmartPtr< SimModObjIF > smo)
 Consumer interface.

void delConsumer (gutz::SmartPtr< SimModObjIF > smo)
gutz::SmartPtr< SimModObjIF > getConsumer (unsigned int i)
 get Consumer

bool isConsumer (const gutz::SmartPtr< SimModObjIF > smo) const
virtual void setForwardModified ()
 Framework interfaces, NOT FOR GENERAL USE, ...


Public Attributes

VEC_TYPE dataVec
 a vector of "ptrs" to the data


Protected Member Functions

 GenDataObj_base (int nObjs, const char *name=0)
virtual void _delData (int i)=0
void updateConsumers ()
 Updates.

virtual void _incCount ()
 gutz::Counted interface, increment reference count by one.

virtual void _decCount ()
 gutz::Counted interface, decrement reference count by one.

virtual int _getCount () const
 gutz::Counted interface, get the current reference count.


Protected Attributes

gutz::SmartPtr< SourceObjIF > _source
 who generated it?

gutz::SmartPtr< SimModObjIF > * _consumers
 who gets it?

int _nConsumers
bool _noForward
bool _modified
bool _forward
bool _updating
std::string _name_
 a text name for the object, SimBase

int _changed
 change id, incremented whenever setChanged is called, SimBase


Friends

class SmartPtr
class SmartPtrRef

Member Typedef Documentation

template<class T, class P>
typedef T GenDataObj_base< T, P >::DATA_TYPE
 

Reimplemented in GenDataObj< T >, GenDataObjNSP< T >, and GenDataObj< Nrro >.

Definition at line 38 of file GenDataObj.h.

template<class T, class P>
typedef P GenDataObj_base< T, P >::PTR_TYPE
 

Reimplemented in GenDataObj< T >, GenDataObjNSP< T >, and GenDataObj< Nrro >.

Definition at line 39 of file GenDataObj.h.

Referenced by GenDataObj_base< Nrro, gutz::SmartPtr< Nrro > >::getData(), and GenDataObj_base< Nrro, gutz::SmartPtr< Nrro > >::setData().

template<class T, class P>
typedef std::vector<PTR_TYPE> GenDataObj_base< T, P >::VEC_TYPE
 

Reimplemented in GenDataObj< T >, GenDataObjNSP< T >, and GenDataObj< Nrro >.

Definition at line 40 of file GenDataObj.h.

Constructor & Destructor Documentation

template<class T, class P>
virtual GenDataObj_base< T, P >::~GenDataObj_base (   )  [inline, virtual]
 

child classes are responsible for deleting their data

Definition at line 44 of file GenDataObj.h.

template<class T, class P>
GenDataObj_base< T, P >::GenDataObj_base (  int  nObjs,
const char *  name = 0
)  [inline, protected]
 

Definition at line 117 of file GenDataObj.h.

Member Function Documentation

virtual void gutz::Counted::_decCount (   )  [inline, protected, virtual, inherited]
 

gutz::Counted interface, decrement reference count by one.

Not generaly used by subclasses, mostly for collaboration with gutz::SmartPtr. Sometimes you need to call this though, see the documentation for gutz::SmartPtr

Definition at line 54 of file smartptr.h.

Referenced by TFImage::clear(), NrroImage::fBlendOverRGBA(), and Nrro::updateMinMax().

template<class T, class P>
virtual void GenDataObj_base< T, P >::_delData (  int  i  )  [protected, pure virtual]
 

Implemented in GenDataObj< T >, GenDataObjNSP< T >, and GenDataObj< Nrro >.

Referenced by GenDataObj_base< Nrro, gutz::SmartPtr< Nrro > >::delData().

virtual int gutz::Counted::_getCount (   )  const [inline, protected, virtual, inherited]
 

gutz::Counted interface, get the current reference count.

Not generaly used by subclasses, mostly for collaboration with gutz::SmartPtr.

Definition at line 58 of file smartptr.h.

virtual void gutz::Counted::_incCount (   )  [inline, protected, virtual, inherited]
 

gutz::Counted interface, increment reference count by one.

Not generaly used by subclasses, mostly for collaboration with gutz::SmartPtr. Sometimes you need to call this though, see the documentation for gutz::SmartPtr

Definition at line 48 of file smartptr.h.

Referenced by TFImage::clear(), NrroImage::fBlendOverRGBA(), and Nrro::updateMinMax().

void DataObj::addConsumer (  gutz::SmartPtr< SimModObjIF >  smo  )  [virtual, inherited]
 

Consumer interface.

Implements DataObjIF.

void DataObj::delConsumer (  gutz::SmartPtr< SimModObjIF >  smo  )  [virtual, inherited]
 

Implements DataObjIF.

template<class T, class P>
void GenDataObj_base< T, P >::delData (  int  i = 0  )  [inline]
 

delete an entry

Definition at line 94 of file GenDataObj.h.

template<class T>
void SimBase::derr (  const char *  when,
const char *  where,
const T  stuff
)  const [inline, inherited]
 

only prints in debug mode, -D_DEBUG

Definition at line 130 of file simBase.h.

References SimBase::_name_.

void SimBase::derr (  const char *  when,
const char *  where = 0
)  const [inline, inherited]
 

only prints in debug mode, -D_DEBUG

Definition at line 113 of file simBase.h.

References SimBase::_name_.

Referenced by AlgObj::addInput(), Key::addKey(), SourceObj::addOutput(), VolShader::bindBlend(), VolField::checkDims(), VolFieldVec::checkField(), VolFieldVec::checkFields(), AlgObj::checkInputs(), AlgObj::delInput(), Key::delKey(), Crank::delMP(), SourceObj::delOutput(), Crank::delTape(), TFGeneric::eval(), SourceObj::execDef(), ColorMapper::execDef(), AlgObj::execDef(), AlgObj::execute(), SourceObj::force(), AlgObj::force(), VolField::genTexture(), TFGeneric::get2DMap(), DataObj::getConsumer(), VolFieldVec::getField(), AlgObj::getInputN(), Key::getKey(), Crank::getMP(), Crank::getMPIdx(), SourceObj::getOutputN(), Crank::getTape(), AlgObj::inputsModified(), Crank::insertTape(), Crank::kindErr(), VolyCube::loadNrro(), VolyCube::readState(), Volytope::readState(), SourceObj::request(), DataObj::request_(), VolytopeVec::setField(), SourceObj::setForwardModified(), DataObj::setForwardModified(), TFGeneric::setImage(), AlgObj::setInputN(), Key::setKey(), Crank::setMP(), VolField::setNrro(), SourceObj::setOutputN(), Crank::setTape(), Volume::update(), SourceObj::updateOutputs(), Volume::updateRectLin(), Volume::updateVolytopesRL(), VolyCube::VolyCube(), and Volytope::writeState().

virtual int SimBase::getChangeID (   )  const [inline, virtual, inherited]
 

Definition at line 73 of file simBase.h.

References SimBase::_changed.

virtual int SimBase::getChangeID (   )  [inline, virtual, inherited]
 

Reimplemented in TFGeneric, TFBaseSP, and TFEltSP.

Definition at line 72 of file simBase.h.

References SimBase::_changed.

Referenced by TFEltSP::getChangeID(), TFBaseSP::getChangeID(), and TFGeneric::getChangeID().

SimModObjSP DataObj::getConsumer (  unsigned int  i  )  [virtual, inherited]
 

get Consumer

Implements DataObjIF.

Definition at line 217 of file DataObj.cpp.

References DataObj::_consumers, DataObj::_nConsumers, SimBase::derr(), and SimModObjSP.

template<class T, class P>
PTR_TYPE GenDataObj_base< T, P >::getData (  int  i = 0  )  [inline]
 

safe way to get the data, zeroth by default

Definition at line 65 of file GenDataObj.h.

std::string SimBase::getName (   )  [inline, inherited]
 

Definition at line 45 of file simBase.h.

References SimBase::_name_.

Referenced by MetaProg::operator<<().

std::string SimBase::getObjName (   )  [inline, inherited]
 

Definition at line 44 of file simBase.h.

References string.

bool DataObj::isConsumer (  const gutz::SmartPtr< SimModObjIF >  smo  )  const [virtual, inherited]
 

Implements DataObjIF.

bool SimCore::isForwardModified (   )  [inline, inherited]
 

is this thing aready marked for future update?

Definition at line 63 of file simCore.h.

References SimCore::_forward.

bool SimCore::isModified (   )  const [inline, inherited]
 

Definition at line 40 of file simCore.h.

References SimCore::_modified.

template<class T, class P>
void GenDataObj_base< T, P >::pack (   )  [inline]
 

pack vector

Definition at line 102 of file GenDataObj.h.

virtual std::istream& SimCore::readSelf (  std::istream &  is  )  [inline, virtual, inherited]
 

unserialize

Reimplemented from SimBase.

Definition at line 52 of file simCore.h.

bool DataObj::request_ (   )  [virtual, inherited]
 

Request Interface, propigates down the chain.

no reqests pass if we are forward modified

this is modified

see if source has work to do

nope source is good, so are we

hmm, can't go we aren't ready

not modified, not forward modified, must be good

Implements DataObjIF.

Definition at line 86 of file DataObj.cpp.

References SimCore::_forward, SimCore::_modified, DataObj::_source, DataObjSP, SimBase::derr(), and gutz::SmartPtr< SourceObjIF >::isNull().

virtual std::ostream& SimCore::saveSelf (  std::ostream &  os  )  [inline, virtual, inherited]
 

serialize

Reimplemented from SimBase.

Definition at line 50 of file simCore.h.

virtual void SimBase::setChanged (   )  [inline, virtual, inherited]
 

Definition at line 74 of file simBase.h.

References SimBase::_changed.

Referenced by TFEltSP::getChangeID(), TFBaseSP::getChangeID(), TFBaseSP::operator=(), and TFGeneric::update().

template<class T, class P>
void GenDataObj_base< T, P >::setData (  PTR_TYPE  d  )  [inline]
 

set zeroth entry for convenience

Definition at line 84 of file GenDataObj.h.

template<class T, class P>
void GenDataObj_base< T, P >::setData (  int  i,
PTR_TYPE  d
)  [inline]
 

safe way to set the data

Definition at line 74 of file GenDataObj.h.

void DataObj::setForwardModified (   )  [virtual, inherited]
 

Framework interfaces, NOT FOR GENERAL USE, ...

ignore these

Implements SimCore.

Definition at line 249 of file DataObj.cpp.

References DataObj::_consumers, SimCore::_forward, DataObj::_nConsumers, DataObj::_noForward, SimBase::derr(), and gutz::SmartPtr< SimModObjIF >::isNull().

void SimCore::setModified (  bool  mod = true  )  [inline, inherited]
 

Definition at line 41 of file simCore.h.

References SimCore::_modified.

Referenced by EventData::setEvent().

void SimBase::setName (  const char *  name  )  [inline, inherited]
 

Definition at line 47 of file simBase.h.

References SimBase::_name_, and name.

void SimBase::setName (  std::string  name  )  [inline, inherited]
 

Reimplemented in Key.

Definition at line 46 of file simBase.h.

References SimBase::_name_, and name.

Referenced by EventData::EventData(), and GenDataObj_base< Nrro, gutz::SmartPtr< Nrro > >::GenDataObj_base().

virtual void DataObj::setSource (  gutz::SmartPtr< SourceObjIF >  source  )  [virtual, inherited]
 

Source interface.

Implements DataObjIF.

template<class T, class P>
int GenDataObj_base< T, P >::size (   )  [inline]
 

restate the size

Definition at line 61 of file GenDataObj.h.

Referenced by GenDataObj_base< Nrro, gutz::SmartPtr< Nrro > >::delData(), GenDataObj_base< Nrro, gutz::SmartPtr< Nrro > >::getData(), GenDataObj_base< Nrro, gutz::SmartPtr< Nrro > >::pack(), and GenDataObj_base< Nrro, gutz::SmartPtr< Nrro > >::setData().

void DataObj::update_ (   )  [virtual, inherited]
 

Update Interface, propigates down the chain.

derr("updateConsumer()");

Implements DataObjIF.

Definition at line 57 of file DataObj.cpp.

References DataObj::_consumers, SimCore::_forward, SimCore::_modified, DataObj::_nConsumers, SimCore::_updating, DataObjSP, and gutz::SmartPtr< SimModObjIF >::isNull().

void DataObj::updateConsumers (   )  [protected, inherited]
 

Updates.

Definition at line 281 of file DataObj.cpp.

Friends And Related Function Documentation

friend class SmartPtr [friend, inherited]
 

Definition at line 40 of file smartptr.h.

Referenced by Nrro::NrroIter< T >::NrroIter().

friend class SmartPtrRef [friend, inherited]
 

Definition at line 41 of file smartptr.h.

Member Data Documentation

int SimBase::_changed [protected, inherited]
 

change id, incremented whenever setChanged is called, SimBase

Definition at line 103 of file simBase.h.

Referenced by SimBase::getChangeID(), SimBase::setChanged(), and SimBase::SimBase().

gutz::SmartPtr<SimModObjIF>* DataObj::_consumers [protected, inherited]
 

who gets it?

Definition at line 130 of file DataObj.h.

Referenced by DataObj::getConsumer(), DataObj::setForwardModified(), DataObj::update_(), and DataObj::~DataObj().

bool SimCore::_forward [protected, inherited]
 

Definition at line 74 of file simCore.h.

Referenced by SourceObj::force(), AlgObj::force(), SimCore::isForwardModified(), SourceObj::request(), DataObj::request_(), SourceObj::setForwardModified(), DataObj::setForwardModified(), AlgObj::setForwardModified(), SimCore::SimCore(), DataObj::update_(), and AlgObj::update_().

bool SimCore::_modified [protected, inherited]
 

Definition at line 73 of file simCore.h.

Referenced by AlgObj::execute(), SourceObj::force(), AlgObj::force(), SimCore::isModified(), SourceObj::request(), DataObj::request_(), SimCore::setModified(), SimCore::SimCore(), DataObj::update_(), and AlgObj::update_().

std::string SimBase::_name_ [protected, inherited]
 

a text name for the object, SimBase

Definition at line 101 of file simBase.h.

Referenced by SimBase::derr(), SimBase::getName(), SimBase::setName(), and SimBase::SimBase().

int DataObj::_nConsumers [protected, inherited]
 

Definition at line 131 of file DataObj.h.

Referenced by DataObj::getConsumer(), DataObj::setForwardModified(), and DataObj::update_().

bool DataObj::_noForward [protected, inherited]
 

Definition at line 132 of file DataObj.h.

Referenced by DataObj::setForwardModified().

gutz::SmartPtr<SourceObjIF> DataObj::_source [protected, inherited]
 

who generated it?

Definition at line 127 of file DataObj.h.

Referenced by DataObj::request_().

bool SimCore::_updating [protected, inherited]
 

Definition at line 75 of file simCore.h.

Referenced by SimCore::SimCore(), DataObj::update_(), and SourceObj::updateOutputs().

template<class T, class P>
VEC_TYPE GenDataObj_base< T, P >::dataVec
 

a vector of "ptrs" to the data

Definition at line 53 of file GenDataObj.h.

Referenced by GenDataObj_base< Nrro, gutz::SmartPtr< Nrro > >::GenDataObj_base(), GenDataObj_base< Nrro, gutz::SmartPtr< Nrro > >::getData(), GenDataObj_base< Nrro, gutz::SmartPtr< Nrro > >::pack(), GenDataObj_base< Nrro, gutz::SmartPtr< Nrro > >::setData(), and GenDataObj_base< Nrro, gutz::SmartPtr< Nrro > >::size().

The documentation for this class was generated from the following file:
Send questions, comments, and bug reports to:
jmk