Implements a digital waveguide module for cylinders.

The module has two input and two output ports:

p1p Input port for the forwards traveling wave.
p2p Output port for the forwards traveling wave.
p1m Input port for the backwards traveling wave.
p2m Input port for the backwards traveling wave.

The user can specify the following local parameters:

type defines the type of the fractional delay filter and can either be "lagrange" or "thiran". Defaults to "lagrange".
length defines the length of the cylinder in m. Defaults to 0.05, i.e. 50 mm.

The main advantage of using this module instead of the fractionalDelayModule if the fact that every parameter will be defined automatically - there is no need the define the filter order manually and check boundary conditions.

Inheritance diagram for DWGcylinderModule:

Public Member Functions
	DWGcylinderModule (const string &name="DWGCylinderModule", const string &sds="", const string &lds="", const string &htm="")
	Constructor of the DWGcylinderModule class.
virtual ARTItimeModule *	Create (const string &name, const string &sds="", const string &lds="", const string &htm="")
	Factory function which creates a new DWG cylinder module object with the given input parameters.
virtual void	addIPort (const string &name, const ARTdataProp *refPort)
	Adds a new input port to the current time module.
virtual ARTdataProp *	getPort (const string &name)
	Returns a pointer to the port object with the given name.
virtual void	setCurrentIndex (int idx)
	Sets the current time module and all output ports to the given time index.
virtual void	simulateCurrentIndex (int idx)
	Triggers the evaluation of all output ports of the time module for the given time index.
virtual	~DWGcylinderModule ()
	Destructor of the DWGcylinderModule class.
Public Member Functions inherited from genericDelayModule
	genericDelayModule (const string &name, const string &sds="", const string &lds="", const string &htm="")
	Constructor of the genericDelayModule class.
	~genericDelayModule ()
	Destructor of the genericDelayModule class.
Public Member Functions inherited from ARTItimeModule
	ARTItimeModule (const string &name, const string &sds="", const string &lds="", const string &htm="")
	Constructor of the ARTItimeModule class.
	ARTItimeModule (const ARTItimeModule &orig)
	Copy constructor which creates a new time module based on the given time module.
virtual void	setLocalParameter (const string &name, const string &expr)
	Sets the definition of the local parameter with the given name.
virtual void	setLocalParameter (const string &name, const std::complex< double > &val)
	Sets the definition of the local parameter with the given name.
virtual void	setLocalParameter (const string &name, const double val)
	Sets the definition of the local parameter with the given name.
virtual void	addGlobalParameter (const ARTdataProp *parameter)
	Adds a global parameter to the current time module by registering it to all output ports and local parameters.
virtual void	removeGlobalParameter (const string &name)
	Removes the definition of the given global parameter from all output ports and local parameters.
virtual void	setSimulator (ARTsimulator *sim)
	Sets the simulator of the current time module and all its output ports.
virtual	~ARTItimeModule ()
	Destructor of the ARTItimeModule class.
Public Member Functions inherited from ARTobject
	ARTobject (const string name, const string sds="", const string lds="", const string htm="")
	objects must have a name, the rest is optional
	ARTobject (const ARTobject &orig)
	copy constructor
virtual ARTcell *	clone ()
ARTproperty *	GetProperties (ARTproperty *pos)
	iterate through property list (pass NULL to restart iteration, receive NULL after last element)
ARTproperty *	FindProperty (const string nam)
	find and return named property (or return NULL if no match)
ARTproperty *	AppendProperty (const string name, const string sds="", const string lds="", const string htm="")
	Append new property with given name to ARTobject.
ARTdataProp *	AppendDataProp (const string name, ARTvariant *val, const string sds="", const string lds="", const string htm="")
	append new data property with given name to ARTobject
ARTdataProp *	AppendDataProp (const string name, const double val, const string sds="", const string lds="", const string htm="")
ARTdataProp *	AppendDataProp (const string name, const float val, const string sds="", const string lds="", const string htm="")
ARTdataProp *	AppendDataProp (const string name, const string val, const string sds="", const string lds="", const string htm="")
ARTdataProp *	AppendDataProp (const string name, const int val, const string sds="", const string lds="", const string htm="")
ARTdataProp *	AppendDataProp (const string name, const string *val, const string sds="", const string lds="", const string htm="")
ARTdataProp *	AppendDataProp (ARTdataProp *dataProp)
ARTlistProp *	AppendListProp (const string name, const string sds="", const string lds="", const string htm="")
	append new listableProperty with given name
bool	DeleteProperty (ARTproperty *prp)
	delete current property (which was recently accessed by GetProperties, FindProperty or AppendProperty)
ARTmethod *	GetMethods (ARTmethod *pos)
	iterate through method list (pass NULL to restart iteration, receive NULL after last element)
ARTmethod *	FindMethod (const string nam)
	find and return named method (or return NULL if no match)
ARTmethod *	AppendMethod (const string name, const string sds="", const string lds="", const string htm="")
	append new method with given name
bool	DeleteMethod (ARTmethod *mtd)
	delete current method (which was recently accessed by GetProperties, FindProperty or AppendProperty)
void	SetPropertyList (list< ARTproperty * > &l)
void	CopyPropertyListEntries (ARTobject *obj)
	copies properties from other objects (also copying the objects of all list-entries). OVERWRITES list own list!
void	CopyMethodListEntries (ARTobject *obj)
	copies methods from other objects (also copying the objects of all list-entries). OVERWRITES list own list!
list< ARTproperty * >	GetPropertyList ()
list< ARTmethod * >	GetMethodList ()
Public Member Functions inherited from ARTcell
	ARTcell (const string name="", const string sds="", const string lds="", const string htm="")
	ARTcell (const ARTcell &orig)
const string &	GetName () const
const string &	GetShortDescription () const
const string &	GetLongDescription () const
const string &	GetHelpFilename () const
void	SetName (const string name)

Protected Member Functions
virtual void	initLocalParams ()
	Internal method which creates and initializes all needed local parameters.
virtual void	initSimulation ()
	Internal method which prepares the cylinder function based on the given filter type and delay by referring to the global sampling period parameter "T".
Protected Member Functions inherited from genericDelayModule
virtual double	getLagrangeParams (int n, int N, double D)
	Calculates the Lagrange filter parameters for the given input values.
virtual double	getThiranParams (int n, int N, double D)
	Calculates the Thiran filter parameters for the given input values.
virtual double	fac (int n)
	Returns the faculty (n!) of the given number.
virtual double	binom (int n, int k)
	Returns the binomial coefficient for "n choose k".

Protected Attributes
IPortType *	p1p_
	Forwards traveling wave left input port.
OPortType *	p2p_
	Forwards traveling wave right output port.
OPortType *	p1m_
	Backwards traveling wave left output port.
IPortType *	p2m_
	Backwards traveling wave right input port.
OPortType *	p1pbuf_
	Internal buffer for time delays - forwards traveling wave.
OPortType *	p2mbuf_
	Internal buffer for time delays - backwards traveling wave.

Constructor & Destructor Documentation

DWGcylinderModule::DWGcylinderModule	(	const string &	name = `"DWGCylinderModule"`,
		const string &	sds = `""`,
		const string &	lds = `""`,
		const string &	htm = `""`
	)

explicit

Constructor of the DWGcylinderModule class.

Parameters

[in]	name	Represents the unique identifier of the DWG cylinder module.
[in]	sds	Short description (single line) of the DWG cylinder module.
[in]	lds	Long description of the DWG cylinder module.
[in]	htm	Path to help file in HTML format.

Member Function Documentation

void DWGcylinderModule::addIPort	(	const string &	name,
		const ARTdataProp *	refPort
	)

virtual

Adds a new input port to the current time module.

Parameters

[in]	name	Locally unique identifier of the new input port. Either has to be "p1p" or "p2m" for the DWG cylinder module.
[in]	refPort	Pointer to an existing output port which will be associated with the new input port.

Exceptions

ARTerror If the given name is different to "p1p" or "p2m" or the provided port is no valid output port object.

Implements ARTItimeModule.

ARTItimeModule * DWGcylinderModule::Create	(	const string &	name,
		const string &	sds = `""`,
		const string &	lds = `""`,
		const string &	htm = `""`
	)

virtual

Factory function which creates a new DWG cylinder module object with the given input parameters.

Parameters

[in]	name	Represents the unique identifier of the DWG cylinder module.
[in]	sds	Short description (single line) of the DWG cylinder module.
[in]	lds	Long description of the DWG cylinder module.
[in]	htm	Path to help file in HTML format.

Implements ARTItimeModule.

Reimplemented in DWGconeModule.

ARTdataProp * DWGcylinderModule::getPort ( const string & name )

virtual

Returns a pointer to the port object with the given name.

The DWG cylinder module only has valid names for output ports which are called "p2p" or "p1m". Trying to get any other property with another name will trigger an exception.

Exceptions

ARTerror If no port with the given name could be found in the current module.

Reimplemented from ARTItimeModule.

void DWGcylinderModule::initSimulation ( )

protectedvirtual

Internal method which prepares the cylinder function based on the given filter type and delay by referring to the global sampling period parameter "T".

Exceptions

ARTerror If the global parameter "c" for sound velocity cannot be found and the method was neither "lagrange" nor "thiran".

Reimplemented in DWGconeModule.

void DWGcylinderModule::setCurrentIndex ( int idx )

virtual

Sets the current time module and all output ports to the given time index.

Parameters

[in] idx The time index which will be set.

Implements ARTItimeModule.

void DWGcylinderModule::simulateCurrentIndex ( int idx )

virtual

Triggers the evaluation of all output ports of the time module for the given time index.

Parameters

[in] idx The time index which will be simulated.

Implements ARTItimeModule.

Member Data Documentation

OPortType* DWGcylinderModule::p1m_

protected

Backwards traveling wave left output port.

IPortType* DWGcylinderModule::p1p_

protected

Forwards traveling wave left input port.

OPortType* DWGcylinderModule::p1pbuf_

protected

Internal buffer for time delays - forwards traveling wave.

IPortType* DWGcylinderModule::p2m_

protected

Backwards traveling wave right input port.

OPortType* DWGcylinderModule::p2mbuf_

protected

Internal buffer for time delays - backwards traveling wave.

OPortType* DWGcylinderModule::p2p_

protected

Forwards traveling wave right output port.

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation