suanPan
CustomAmplitude Class Referencefinal

An Amplitude class that can generate Amplitude pattern. More...

#include <CustomAmplitude.h>

Inheritance diagram for CustomAmplitude:
Collaboration diagram for CustomAmplitude:

Public Member Functions

 CustomAmplitude (unsigned, unsigned, unsigned)
 
void initialize (const shared_ptr< DomainBase > &) override
 
double get_amplitude (double) override
 
void print () override
 
- Public Member Functions inherited from Amplitude
 Amplitude (unsigned=0, unsigned=0)
 
 ~Amplitude () override=default
 
virtual void initialize (const shared_ptr< DomainBase > &)
 
virtual double get_amplitude (double)
 
void set_start_step (unsigned)
 
unsigned get_start_step () const
 
void set_start_time (double)
 
double set_start_time () const
 
- Public Member Functions inherited from Tag
 Tag (unsigned=0)
 
 Tag (const Tag &)=default
 
 Tag (Tag &&)=default
 
Tagoperator= (const Tag &)=delete
 
Tagoperator= (Tag &&)=delete
 
virtual ~Tag ()=default
 
void set_tag (unsigned) const
 
unsigned get_tag () const
 
void enable ()
 
void disable ()
 
void guard ()
 
void unguard ()
 
bool is_active () const
 
bool is_guarded () const
 
virtual void print ()
 

Additional Inherited Members

- Protected Attributes inherited from Amplitude
unsigned start_step
 
double start_time = 0.
 

Detailed Description

An Amplitude class that can generate Amplitude pattern.

Author
tlc
Date
26/03/2023
Version
0.1.0

Constructor & Destructor Documentation

◆ CustomAmplitude()

CustomAmplitude::CustomAmplitude ( unsigned  T,
unsigned  ET,
unsigned  ST 
)

Member Function Documentation

◆ get_amplitude()

double CustomAmplitude::get_amplitude ( double  T)
overridevirtual

Reimplemented from Amplitude.

Here is the call graph for this function:

◆ initialize()

void CustomAmplitude::initialize ( const shared_ptr< DomainBase > &  D)
overridevirtual

Reimplemented from Amplitude.

Here is the call graph for this function:

◆ print()

void CustomAmplitude::print ( )
overridevirtual

Reimplemented from Tag.


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