UNIVERS  15.3
UNIVERS base processing software API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Attributes | List of all members
sim::Impulse Class Referenceabstract

#include <sim_impulse.hpp>

Inheritance diagram for sim::Impulse:
sim::DiracImpulse sim::RickerImpulse sim::UserImpulse

Public Member Functions

 Impulse (const AmplT &gain=1.)
 
virtual Impulseclone () const =0
 
virtual void setGain (const AmplT &gain)
 
virtual const AmplT & gain () const
 
virtual AmplT operator() (const TimeT &t) const =0
 
virtual ImpulseType type () const =0
 

Protected Attributes

AmplT m_gain
 

Detailed Description

Abstract impulse.

Constructor & Destructor Documentation

sim::Impulse::Impulse ( const AmplT &  gain = 1.)
inline
Construct impulse with gain provided.
Parameters
gainGain of the impulse amplitudes.

Member Function Documentation

virtual Impulse* sim::Impulse::clone ( ) const
pure virtual
Clone the object. 
Returns
new pointer to Impulse, should be deleted.

Implemented in sim::UserImpulse, sim::DiracImpulse, and sim::RickerImpulse.

virtual AmplT sim::Impulse::operator() ( const TimeT &  t) const
pure virtual
Calculates impulse for provided time. 
Parameters
t- time in (ms).

Implemented in sim::UserImpulse, sim::DiracImpulse, and sim::RickerImpulse.

virtual ImpulseType sim::Impulse::type ( ) const
pure virtual
Type of the impulse. 
Returns
this impulse type

Implemented in sim::UserImpulse, sim::DiracImpulse, and sim::RickerImpulse.


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