sinusoid.h
Go to the documentation of this file.
1 /*********************************************************************
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2009, Willow Garage, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of the Willow Garage nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *********************************************************************/
34 
37 #ifndef CONTROL_TOOLBOX__SINUSOID_H_
38 #define CONTROL_TOOLBOX__SINUSOID_H_
39 
40 #include <tinyxml.h>
41 
42 namespace control_toolbox
43 {
44 
53 class Sinusoid
54 {
55 public:
59  Sinusoid();
60 
69  Sinusoid(double offset, double amplitude, double frequency, double phase);
70 
74  virtual ~Sinusoid();
75 
82  bool initXml(TiXmlElement *ti_xml_element);
83 
87  void debug();
88 
97  double update(double time, double& qd, double& qdd);
98 
99 private:
100  double offset_;
101  double amplitude_;
102  double frequency_;
103  double phase_;
104 };
105 
106 }
107 
108 #endif /* SINUSOID_H_ */
control_toolbox::Sinusoid::amplitude_
double amplitude_
Definition: sinusoid.h:133
control_toolbox::Sinusoid::~Sinusoid
virtual ~Sinusoid()
Definition: sinusoid.cpp:68
control_toolbox::Sinusoid::frequency_
double frequency_
Definition: sinusoid.h:134
control_toolbox::Sinusoid::offset_
double offset_
Definition: sinusoid.h:132
control_toolbox::Sinusoid::debug
void debug()
Definition: sinusoid.cpp:88
control_toolbox::Sinusoid::initXml
bool initXml(TiXmlElement *ti_xml_element)
Initializes the parameters of the sine wave from the given xml element.
Definition: sinusoid.cpp:54
control_toolbox
Definition: dither.h:46
control_toolbox::Sinusoid::phase_
double phase_
Definition: sinusoid.h:135
control_toolbox::Sinusoid::update
double update(double time, double &qd, double &qdd)
Gets the value and derivatives of the sinusoid at a given time.
Definition: sinusoid.cpp:76
control_toolbox::Sinusoid::Sinusoid
Sinusoid()
Constructor.
Definition: sinusoid.cpp:72


control_toolbox
Author(s): Melonee Wise, Sachin Chitta, John Hsu
autogenerated on Wed May 11 2022 02:09:47