ispike::Channel Class Reference

#include <Channel.hpp>

Inheritance diagram for ispike::Channel:

List of all members.

Public Member Functions
	Channel ()
virtual	~Channel ()
int	getId ()
void	setId (int id)
int	getWidth ()
void	setWidth (int width)
int	getHeight ()
void	setHeight (int height)
unsigned	size ()
string	getDescription ()
void	setDescription (std::string description)
virtual void	step ()=0
Protected Member Functions
bool	isInitialized ()
void	setInitialized (bool initialized)
Protected Attributes
int	id
unsigned	width
unsigned	height
string	description

---

Detailed Description

Abstract class holding properties common to all input and output channels

Definition at line 15 of file Channel.hpp.

---

Constructor & Destructor Documentation

ispike::Channel::Channel

(

)

[inline]

Definition at line 17 of file Channel.hpp.

virtual ispike::Channel::~Channel

(

)

[inline, virtual]

Definition at line 18 of file Channel.hpp.

---

Member Function Documentation

string ispike::Channel::getDescription

(

)

[inline]

Retrieves the description of a Channel

Definition at line 42 of file Channel.hpp.

int ispike::Channel::getHeight

(

)

[inline]

Retrieves the height of the Channel

Definition at line 33 of file Channel.hpp.

int ispike::Channel::getId

(

)

[inline]

Retrieves the Channel Identifier

Definition at line 21 of file Channel.hpp.

int ispike::Channel::getWidth

(

)

[inline]

Retrieves the width of the Channel

Definition at line 27 of file Channel.hpp.

bool ispike::Channel::isInitialized

(

)

[inline, protected]

Definition at line 67 of file Channel.hpp.

void ispike::Channel::setDescription

(

std::string

description

)

[inline]

Sets the description of a Channel

Definition at line 45 of file Channel.hpp.

void ispike::Channel::setHeight

(

int

height

)

[inline]

Sets the height of the Channel

Definition at line 36 of file Channel.hpp.

void ispike::Channel::setId

(

int

id

)

[inline]

Sets the identifier of the Channel

Definition at line 24 of file Channel.hpp.

void ispike::Channel::setInitialized

(

bool

initialized

)

[inline, protected]

Definition at line 68 of file Channel.hpp.

void ispike::Channel::setWidth

(

int

width

)

[inline]

Sets the width of the Channel

Definition at line 30 of file Channel.hpp.

unsigned ispike::Channel::size

(

)

[inline]

Returns the size of the channel

Definition at line 39 of file Channel.hpp.

virtual void ispike::Channel::step

(

)

[pure virtual]

Advances the channel by one time step

Implemented in ispike::VisualInputChannel, ispike::JointInputChannel, and ispike::JointOutputChannel.

---

Member Data Documentation

string ispike::Channel::description [protected]

Channel Description

Definition at line 63 of file Channel.hpp.

unsigned ispike::Channel::height [protected]

Neuron Height

Definition at line 60 of file Channel.hpp.

int ispike::Channel::id [protected]

Channel Identifier

Definition at line 54 of file Channel.hpp.

unsigned ispike::Channel::width [protected]

Neuron Width

Definition at line 57 of file Channel.hpp.

---

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

• D:/Home/Programs/iSpike/include/iSpike/Channel/Channel.hpp