SimStructure Class Reference

Inheritance diagram for SimStructure:
Inheritance graph
[legend]
Collaboration diagram for SimStructure:
Collaboration graph
[legend]

List of all members.

Public Types

typedef CreateFunctor
< SimStructure, ParamList
< BorderPolicy, SimTime, uint,
uint > > 
Creator
typedef GenericFactory
< SimStructure, std::string,
Creator > 
Factory

Public Member Functions

 SimStructure (const uint width, const uint height, const std::string name="", const std::string units="")
 constructor
virtual ~SimStructure ()
 destructor
virtual void input (const Image< double > &in, const int pos=-1)=0
 set the input
virtual void inputExc (const Image< double > &in, const int pos=-1)=0
 set the input
virtual void inputInh (const Image< double > &in, const int pos=-1)=0
 set the input
virtual Image< double > getOutput (const int pos=-1) const =0
 get the current output
virtual Image< double > getDisplayOutput (const int pos=-1) const
 get the current display output
virtual void evolve (const SimTime &simtime)=0
 evolve up to specified time
virtual void getSimUnit (const Location &loc, std::vector< const SimUnit * > &units)=0
 get unit(s) at desired location
virtual void editSimUnit (const Location &loc, std::vector< SimUnit * > &units)=0
 edit unit(s) at the desired output position
virtual const uint numSubs () const
virtual const SimStructuregetSub (const uint sub) const
virtual SimStructureeditSub (const uint sub)
void setName (const std::string &name)
 set units type
void setUnits (const std::string &units)
 set units type
virtual void initialize ()=0
virtual void setTime (const SimTime &time, const bool recursive=true)=0
 set simulation time step
const std::string getName () const
 get name
const std::string getUnits () const
 get units
const Dims getOutDims () const
 get output dimensions
const uint getOutWidth () const
 get the width
const uint getOutHeight () const
 get the height
const uint getOutSize () const
 get the total output size
virtual const SimTime getTime () const =0
 get simulation time step
virtual const SimTime getTimeStep () const =0
 get simulation time step
virtual SimStructureclone () const =0
 clone the module

Protected Member Functions

 SimStructure (const SimStructure &nlc)
SimStructureoperator= (const SimStructure &nlc)

Static Protected Member Functions

static void splitExcInh (const Image< double > &input, Image< double > &Exc, Image< double > &Inh)

Detailed Description

Definition at line 58 of file SimStructure.H.


Constructor & Destructor Documentation

SimStructure::SimStructure ( const uint  width,
const uint  height,
const std::string  name = "",
const std::string  units = "" 
) [inline]

constructor

Definition at line 181 of file SimStructure.H.

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

destructor

Definition at line 69 of file SimStructure.H.


Member Function Documentation

virtual SimStructure* SimStructure::clone (  )  const [pure virtual]
virtual void SimStructure::editSimUnit ( const Location loc,
std::vector< SimUnit * > &  units 
) [pure virtual]
virtual void SimStructure::evolve ( const SimTime simtime  )  [pure virtual]

evolve up to specified time

Implemented in SimLayer, Structure< T >, Structure< SimStructure * >, and Structure< SimLayer * >.

Image< double > SimStructure::getDisplayOutput ( const int  pos = -1  )  const [inline, virtual]
const std::string SimStructure::getName ( void   )  const [inline]

get name

Definition at line 231 of file SimStructure.H.

const Dims SimStructure::getOutDims (  )  const [inline]

get output dimensions

Definition at line 245 of file SimStructure.H.

Referenced by Layer< T, W >::getDisplayOutput(), and StructurePlot::StructurePlot().

const uint SimStructure::getOutHeight (  )  const [inline]

get the height

Definition at line 259 of file SimStructure.H.

References Dims::h().

virtual Image<double> SimStructure::getOutput ( const int  pos = -1  )  const [pure virtual]

get the current output

Implemented in SimLayer, Structure< T >, Structure< SimStructure * >, and Structure< SimLayer * >.

Referenced by getDisplayOutput().

const uint SimStructure::getOutSize (  )  const [inline]

get the total output size

Definition at line 266 of file SimStructure.H.

References Dims::h(), and Dims::w().

Referenced by Layer< T, W >::numSimUnits().

const uint SimStructure::getOutWidth (  )  const [inline]

get the width

Definition at line 252 of file SimStructure.H.

References Dims::w().

virtual void SimStructure::getSimUnit ( const Location loc,
std::vector< const SimUnit * > &  units 
) [pure virtual]
virtual const SimTime SimStructure::getTime (  )  const [pure virtual]

get simulation time step

Implemented in SimLayer, Structure< T >, Structure< SimStructure * >, and Structure< SimLayer * >.

virtual const SimTime SimStructure::getTimeStep (  )  const [pure virtual]

get simulation time step

Implemented in SimLayer, Structure< T >, Structure< SimStructure * >, and Structure< SimLayer * >.

const std::string SimStructure::getUnits (  )  const [inline]

get units

Definition at line 238 of file SimStructure.H.

Referenced by Structure< T >::addSub(), and Structure< T >::setDefaultIO().

virtual void SimStructure::input ( const Image< double > &  in,
const int  pos = -1 
) [pure virtual]
virtual void SimStructure::inputExc ( const Image< double > &  in,
const int  pos = -1 
) [pure virtual]
virtual void SimStructure::inputInh ( const Image< double > &  in,
const int  pos = -1 
) [pure virtual]
void SimStructure::setName ( const std::string name  )  [inline]

set units type

Definition at line 217 of file SimStructure.H.

virtual void SimStructure::setTime ( const SimTime time,
const bool  recursive = true 
) [pure virtual]
void SimStructure::setUnits ( const std::string units  )  [inline]

set units type

Definition at line 224 of file SimStructure.H.

Referenced by Structure< T >::addSub(), and Structure< T >::setDefaultIO().


The documentation for this class was generated from the following file:
Generated on Sun May 8 08:43:49 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3