Structure< T > Class Template Reference

Inheritance diagram for Structure< T >:

[legend]

Collaboration diagram for Structure< T >:

[legend]

List of all members.

Public Member Functions
	Structure (const SimTime &timeStep, const uint w=40, const uint h=30, const std::string name="", const std::string units="")
	constructor
virtual	~Structure ()
	default assignment and copy constructor OK
void	input (const Image< double > &in, const int pos=-1)
	set the input
void	inputExc (const Image< double > &in, const int pos=-1)
	set the input
void	inputInh (const Image< double > &in, const int pos=-1)
	set the input
virtual Image< double >	getOutput (const int pos=-1) const
	get the current output
virtual Image< double >	getDisplayOutput (const int pos=-1) const
	get the current display output
void	setDefaultIO (const uint input_pos, const uint output_pos)
	set the default input and output modules
void	evolve (const SimTime &simtime)
	evolve up to specified time
void	initialize ()
	reset/initialize
void	getSimUnit (const Location &loc, std::vector< const SimUnit * > &units)
	get unit(s) at desired location
void	editSimUnit (const Location &loc, std::vector< SimUnit * > &units)
	edit unit(s) at the desired output position
void	setTime (const SimTime &time, const bool recursive=true)
	set simulation time step
const uint	numSubs () const
const nsu::TypeTraits< T > ::PointeeType &	getSub (const uint sub) const
nsu::TypeTraits< T >::PointeeType &	editSub (const uint pos)
	get the unit at desired position mutable version
const SimTime	getTime () const
	get simulation time step
const SimTime	getTimeStep () const
	get simulation time step
virtual Structure *	clone () const =0
	clone the module
Protected Member Functions
	Structure (const Structure< T > &nlc)
Structure< T > &	operator= (const Structure< T > &nlc)
void	addSub (const typename nsu::TypeTraits< T >::PointeeType &structure)
	add a sub module

---

Detailed Description

template<class T>
class Structure< T >

Definition at line 69 of file Structure.H.

---

Constructor & Destructor Documentation

template<class T >

Structure< T >::Structure	(	const SimTime &	timeStep,
		const uint	w = 40,
		const uint	h = 30,
		const std::string	name = "",
		const std::string	units = ""
	)			[inline]

constructor

Definition at line 189 of file Structure.H.

template<class T>

virtual Structure< T >::~Structure

(

)

[inline, virtual]

default assignment and copy constructor OK

Definition at line 78 of file Structure.H.

---

Member Function Documentation

template<class T>

void Structure< T >::addSub

(

const typename nsu::TypeTraits< T >::PointeeType &

structure

)

[inline, protected]

add a sub module

Definition at line 423 of file Structure.H.

References SimStructure::getUnits(), ImageSet< T >::push_back(), SimStructure::setUnits(), and ZEROS.

template<class T>

virtual Structure* Structure< T >::clone

(

)

const [pure virtual]

clone the module

Implements SimStructure.

Implemented in CompLayer< EUnit, IUnit >, NeuralFieldSC, SC, SCTracker, CompLayer< FSNeuron, FSNeuron >, and CompLayer< LowPassSigmoid, LowPassRectify >.

template<class T >

void Structure< T >::editSimUnit	(	const Location &	loc,
		std::vector< SimUnit * > &	units
	)			[inline, virtual]

edit unit(s) at the desired output position

Implements SimStructure.

Definition at line 379 of file Structure.H.

References Structure< T >::editSub().

template<class T >

nsu::TypeTraits< T >::PointeeType & Structure< T >::editSub

(

const uint

pos

)

[inline, virtual]

get the unit at desired position mutable version

Reimplemented from SimStructure.

Definition at line 402 of file Structure.H.

Referenced by Structure< T >::editSimUnit(), Structure< T >::getSimUnit(), and Structure< T >::setTime().

template<class T >

void Structure< T >::evolve

(

const SimTime &

simtime

)

[inline, virtual]

evolve up to specified time

Implements SimStructure.

Definition at line 298 of file Structure.H.

References ImageSet< T >::clear(), SimTime::NSECS(), and SimTime::nsecs().

template<class T >

Image< double > Structure< T >::getDisplayOutput

(

const int

pos = -1

)

const [inline, virtual]

get the current display output

Reimplemented from SimStructure.

Reimplemented in CompLayer< EUnit, IUnit >, CompLayer< FSNeuron, FSNeuron >, and CompLayer< LowPassSigmoid, LowPassRectify >.

Definition at line 275 of file Structure.H.

template<class T >

Image< double > Structure< T >::getOutput

(

const int

pos = -1

)

const [inline, virtual]

get the current output

Implements SimStructure.

Definition at line 263 of file Structure.H.

template<class T >

void Structure< T >::getSimUnit	(	const Location &	loc,
		std::vector< const SimUnit * > &	units
	)			[inline, virtual]

get unit(s) at desired location

Implements SimStructure.

Definition at line 370 of file Structure.H.

References Structure< T >::editSub().

template<class T >

const SimTime Structure< T >::getTime

(

)

const [inline, virtual]

get simulation time step

Implements SimStructure.

Definition at line 409 of file Structure.H.

template<class T >

const SimTime Structure< T >::getTimeStep

(

)

const [inline, virtual]

get simulation time step

Implements SimStructure.

Definition at line 416 of file Structure.H.

template<class T >

void Structure< T >::initialize

(

)

[inline, virtual]

reset/initialize

Implements SimStructure.

Definition at line 348 of file Structure.H.

References SimTime::ZERO().

template<class T >

void Structure< T >::input	(	const Image< double > &	in,
		const int	pos = -1
	)			[inline, virtual]

set the input

Implements SimStructure.

Definition at line 227 of file Structure.H.

References ImageSet< T >::size().

template<class T >

void Structure< T >::inputExc	(	const Image< double > &	in,
		const int	pos = -1
	)			[inline, virtual]

set the input

Implements SimStructure.

Definition at line 239 of file Structure.H.

References ImageSet< T >::size().

template<class T >

void Structure< T >::inputInh	(	const Image< double > &	in,
		const int	pos = -1
	)			[inline, virtual]

set the input

Implements SimStructure.

Definition at line 251 of file Structure.H.

References ImageSet< T >::size().

template<class T >

void Structure< T >::setDefaultIO	(	const uint	input_pos,
		const uint	output_pos
	)			[inline]

set the default input and output modules

Definition at line 287 of file Structure.H.

References SimStructure::getUnits(), and SimStructure::setUnits().

template<class T >

void Structure< T >::setTime	(	const SimTime &	time,
		const bool	recursive = true
	)			[inline, virtual]

set simulation time step

Implements SimStructure.

Definition at line 361 of file Structure.H.

References Structure< T >::editSub().

---

The documentation for this class was generated from the following file:

• src/ModelNeuron/Structure.H