simthlib::Multiply Class Reference

Base class for a general Multiply block. More...

#include <arith.h>

Inheritance diagram for simthlib::Multiply:

[legend]List of all members.

Public Member Functions
virtual void	updateInputLengths ()
virtual void	updateOutputLengths ()
void	print (std::ostream &os) const
Static Public Member Functions
static void	init (const std::string &fileName, simth::Device **dev, simth::DeviceSystemIntf *sysPtr, int ID, const std::string &regionQualifier)
Protected Member Functions
	Multiply (int deviceID, simth::DeviceSystemIntf *system, const simth::PropertyList &pl, unsigned input_ports)
Protected Attributes
unsigned	iports
Related Functions
(Note that these are not member functions.)
	propertylist_Multiply (not_a_function)

---

Detailed Description

Base class for a general Multiply block.

This block multiplies the samples from all input sequences together and by a constant factor. The number of input ports (may be one) and the multiplication factor needs to be specified in the parameter file.

Parameters in Micos parameter file:

type: set this to "<code>multiply</code>"

factor: literal scalar factor to multiply with. The type of this factor has to match the sequence type as specified by the "<code>streamtype</code>" parameter.

input_ports: number of input ports. (optional)

streamtype: String specifying the sequence data type of the input and output port. The names are the ones as defined in signal.h, e.g. bitSeq, ModSeq, symSeq etc.

---

Constructor & Destructor Documentation

simthlib::Multiply::Multiply (  int  deviceID, simth::DeviceSystemIntf *  system, const simth::PropertyList &  pl, unsigned  input_ports )  [protected]

---

Member Function Documentation

static void simthlib::Multiply::init (  const std::string &  fileName, simth::Device **  dev, simth::DeviceSystemIntf *  sysPtr, int  ID, const std::string &  regionQualifier )  [static]

void simthlib::Multiply::print (  std::ostream &  os  )  const [virtual]

Reimplemented from simth::Device.

virtual void simthlib::Multiply::updateInputLengths (   )  [virtual]

Implements simth::Device.

virtual void simthlib::Multiply::updateOutputLengths (   )  [virtual]

Implements simth::Device.

---

Friends And Related Function Documentation

propertylist_Multiply (  not_a_function   )  [related]

These are the properties of class Multiply . This list is auto-generated from the XML-Devicelist of this device by means of an XSLT transformation script. Description of this device in the XML file: The base class for a multiplication block with several input interfaces. The samples of all input sequences are multiplied together. Note that this class also has the Properties of its base classes. The direct base class is simth::Device ; direct link to its propertylist should be propertylist_Device(). The list below usually includes the properties that have been inherited from the base classes; the properties which belong only to this class can be found at the end of this list. input_ports <unsigned>, default "1" -- The number of input interfaces. 1 properties in this class.

---

Member Data Documentation

unsigned simthlib::Multiply::iports [protected]

---