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

SimBase Class Reference

#include <simBase.h>

Inheritance diagram for SimBase:

Crank Key MetaProg SimCore SlicerBase Tape TFBaseSP TFElement TFEltSP TFEltView TFGeneric TFManager VolField VolFieldVec VolRenBase VolShader Volume Volytope VolytopeVec List of all members.

Detailed Description

SimBase, base object for simianlib.

Provides some basic functionality and a common base class for all simian objects.

Definition at line 34 of file simBase.h.

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 ()

Serialization:

from SimBase You MUST override these pure virtual functions, they "should" do something usefull.

It is also nice if you declare a static std::istream &create(std::istream &is) const; function, to create a class from a stream. This is done on a per-concrete class basis.

These aren't pure virutal yet, but will be soon!

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

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


Public Member Functions

 SimBase ()
virtual ~SimBase ()

Protected Attributes

std::string _name_
 a text name for the object, SimBase

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

Constructor & Destructor Documentation

SimBase::SimBase (   )  [inline]
 

Definition at line 36 of file simBase.h.

References _changed, and _name_.

virtual SimBase::~SimBase (   )  [inline, virtual]
 

Definition at line 37 of file simBase.h.

Member Function Documentation

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

only prints in debug mode, -D_DEBUG

Definition at line 130 of file simBase.h.

References _name_.

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

only prints in debug mode, -D_DEBUG

Definition at line 113 of file simBase.h.

References _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]
 

Definition at line 73 of file simBase.h.

References _changed.

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

Reimplemented in TFGeneric, TFBaseSP, and TFEltSP.

Definition at line 72 of file simBase.h.

References _changed.

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

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

Definition at line 45 of file simBase.h.

References _name_.

Referenced by MetaProg::operator<<().

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

Definition at line 44 of file simBase.h.

References string.

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

unserialize

Reimplemented in SimCore, and VolRenBase.

Definition at line 94 of file simBase.h.

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

serialize

Reimplemented in SimCore, and VolRenBase.

Definition at line 92 of file simBase.h.

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

Definition at line 74 of file simBase.h.

References _changed.

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

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

Definition at line 47 of file simBase.h.

References _name_, and name.

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

Reimplemented in Key.

Definition at line 46 of file simBase.h.

References _name_, and name.

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

Member Data Documentation

int SimBase::_changed [protected]
 

change id, incremented whenever setChanged is called, SimBase

Definition at line 103 of file simBase.h.

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

std::string SimBase::_name_ [protected]
 

a text name for the object, SimBase

Definition at line 101 of file simBase.h.

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

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