---

PhysicalModel Class Reference

#include <physicalmodel.h>

Inheritance diagram for PhysicalModel:

List of all members.

---

Detailed Description

Base class of all physical models to be used in CSIM simulations. These models take input from readouts and produce one or more outputs to analog synapses. Within a transform function you can also receive input from any external source.

Public Member Functions

• PhysicalModel (int input_channels=0, int output_channels=0)
• virtual ~PhysicalModel (void)
• virtual int advance (void)

  Calculates the next output of the physical model.
  
  

• virtual int addIncoming (Advancable *Incoming)

  This method will be called if object Incoming wants to send information to this object.
  
  

• virtual int addInput (Advancable *Incoming, char *inputname)

  Connect a readout output to a named input of the model

  Parameters:

  inputname

  Name of the input channel.

  
  
  

• virtual int addOutgoing (Advancable *Outgoing)

  This method will be called if this object wants to send information to object Outgoing.
  
  

• virtual int addOutput (Advancable *Outgoing, char *outputname)

  Connect an output channel of the model to a synapse

  Parameters:

  outputname

  Name of the output channel.

  
  
  

• virtual int transform (double **I, double *O)=0
• virtual void reset ()
• virtual int updateInternal ()
• const char * getInputChannelName (int index)
• const char * getOutputChannelName (int index)

Protected Member Functions

• int register_input_channel (const char *name)

  Register a new input channel

  Parameters:

  name	Name of the new input channel

  Returns:

  Index of the new channel.

  
  
  

• int register_output_channel (const char *name)

  Register a new output channel

  Parameters:

  name	Name of the new output channel

  Returns:

  Index of the new channel.

  
  
  

Protected Attributes

• Advancable ** incoming

  A list of incoming model-inputs.
  
  

• int nIncoming

  Number of inputs.
  
  

• int nIncomingAlloc

  Current size of array (in number of inputs) allocated for inputs.
  
  

• AnalogSynapse *** outgoing

  An array of outgoing synapses.
  
  

• int * nOutgoing

  Number of outgoing synapses per channel.
  
  

• int * nOutgoingAlloc

  Current size of array (in number of synapses) allocated for outgoing synapses per channel.
  
  

• int nOutputChannels

  Number of output channels.
  
  

• map< string, int > input_channel_names

  Mapping of input-channel names to indices.
  
  

• map< string, int > output_channel_names

  Mapping of output-channel names to indices.
  
  

Private Attributes

• double ** inputs

  Storage for input value-pointers.
  
  

• double * outputs

  Storage for output values.
  
  

• int last_input_index

  Last registered input index.
  
  

• int last_output_index

  Last registered output index.
  
  

---

Constructor & Destructor Documentation

PhysicalModel::PhysicalModel (  int    input_channels = 0, int    output_channels = 0 )

Constructs a new physical model. Parameters: input_channels  How many input channels are there? output_channels  How many output channels are there?

PhysicalModel::~PhysicalModel (  void    )  [virtual]

Frees the memory

---

Member Function Documentation

const char * PhysicalModel::getInputChannelName (  int    index )

Returns the names of the input- and output - channels.

const char * PhysicalModel::getOutputChannelName (  int    index )

Returns the name of an output-channel.

virtual void PhysicalModel::reset (  void    )  [inline, virtual]

Resets the information stored within the model. Implements Advancable. Reimplemented in ArmModel.

virtual int PhysicalModel::transform (  double **    I, double *    O )  [pure virtual]

Transforms the current inputs to new output values. Parameters: I  Array of pointers to input values from the readouts. O  Array of output values. Returns: -1 if an error occured, 1 for success. Implemented in ArmModel.

int PhysicalModel::updateInternal (    )  [virtual]

This function is called after parameters are updated. Reimplemented in ArmModel.

---