suanPan
Amplitude.h
Go to the documentation of this file.
1/*******************************************************************************
2 * Copyright (C) 2017-2024 Theodore Chang
3 *
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 ******************************************************************************/
52#ifndef AMPLITUDE_H
53#define AMPLITUDE_H
54
55enum class AmplitudeType {
56 RAMP,
57 TABULAR,
60 DECAY
61};
62
63#include <Domain/Tag.h>
64
65class DomainBase;
66
67class Amplitude : public Tag {
68protected:
69 unsigned start_step;
70 double start_time = 0.; // T0
71public:
72 explicit Amplitude(unsigned = 0, unsigned = 0);
73 ~Amplitude() override = default;
74
75 virtual void initialize(const shared_ptr<DomainBase>&);
76
77 virtual double get_amplitude(double);
78
79 void set_start_step(unsigned);
80 [[nodiscard]] unsigned get_start_step() const;
81
82 void set_start_time(double);
83 [[nodiscard]] double set_start_time() const;
84};
85
86#endif
87
An Amplitude class that can generate Amplitude pattern.
Definition: Amplitude.h:67
virtual void initialize(const shared_ptr< DomainBase > &)
Definition: Amplitude.cpp:24
Amplitude(unsigned=0, unsigned=0)
Definition: Amplitude.cpp:20
unsigned start_step
Definition: Amplitude.h:69
double set_start_time() const
Definition: Amplitude.cpp:34
void set_start_step(unsigned)
Definition: Amplitude.cpp:28
~Amplitude() override=default
unsigned get_start_step() const
Definition: Amplitude.cpp:30
double start_time
Definition: Amplitude.h:70
virtual double get_amplitude(double)
Definition: Amplitude.cpp:26
The DomainBase class is a template.
Definition: DomainBase.h:104
A base Tag class.
Definition: Tag.h:38
AmplitudeType
Definition: Amplitude.h:55