Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
dynamicgraph::sot::tools::Oscillator Class Reference

#include <oscillator.hh>

Inheritance diagram for dynamicgraph::sot::tools::Oscillator:
Inheritance graph
[legend]

Public Member Functions

 Oscillator (const std::string name)
 
- Public Member Functions inherited from dynamicgraph::Entity
virtual void display (std::ostream &os) const
 
std::ostream & displaySignalList (std::ostream &os) const
 
 Entity (const std::string &name)
 
virtual const std::string & getClassName () const
 
const std::string & getCommandList () const
 
virtual std::string getDocString () const
 
LoggerVerbosity getLoggerVerbosityLevel ()
 
LoggerVerbosity getLoggerVerbosityLevel ()
 
const std::string & getName () const
 
command::CommandgetNewStyleCommand (const std::string &cmdName)
 
CommandMap_t getNewStyleCommandMap ()
 
SignalBase< sigtime_t > & getSignal (const std::string &signalName)
 
const SignalBase< sigtime_t > & getSignal (const std::string &signalName) const
 
SignalMap getSignalMap () const
 
double getStreamPrintPeriod ()
 
double getStreamPrintPeriod ()
 
double getTimeSample ()
 
double getTimeSample ()
 
bool hasSignal (const std::string &signame) const
 
Loggerlogger ()
 
Loggerlogger ()
 
const Loggerlogger () const
 
const Loggerlogger () const
 
void sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const std::string &lineId="")
 
void sendMsg (const std::string &msg, MsgType t=MSG_TYPE_INFO, const std::string &lineId="")
 
void setLoggerVerbosityLevel (LoggerVerbosity lv)
 
void setLoggerVerbosityLevel (LoggerVerbosity lv)
 
bool setStreamPrintPeriod (double t)
 
bool setStreamPrintPeriod (double t)
 
bool setTimeSample (double t)
 
bool setTimeSample (double t)
 
virtual SignalBase< sigtime_t > * test ()
 
virtual void test2 (SignalBase< sigtime_t > *)
 
virtual std::ostream & writeCompletionList (std::ostream &os) const
 
virtual std::ostream & writeGraph (std::ostream &os) const
 
virtual ~Entity ()
 

Protected Member Functions

doublecomputeSignal (double &sout, const sigtime_t &t)
 
dynamicgraph::VectorcomputeVectorSignal (dynamicgraph::Vector &vsout, const sigtime_t &t)
 
double value (double dt, double time, double omega, double phase, double amplitude, double bias)
 
- Protected Member Functions inherited from dynamicgraph::Entity
void addCommand (const std::string &name, command::Command *command)
 
void entityDeregistration ()
 
void entityRegistration ()
 
void signalDeregistration (const std::string &name)
 
void signalRegistration (const SignalArray< sigtime_t > &signals)
 

Protected Attributes

SignalPtr< double, sigtime_tangularFrequencySIN_
 
SignalPtr< double, sigtime_tbiasSIN_
 
bool continuous_
 
double dt_
 
double epsilon_
 
double lastValue_
 
SignalPtr< double, sigtime_tmagnitudeSIN_
 
SignalPtr< double, sigtime_tphaseSIN_
 
SignalTimeDependent< double, sigtime_tsoutSOUT_
 
bool started_
 
SignalTimeDependent< dynamicgraph::Vector, sigtime_tvectorSoutSOUT_
 
- Protected Attributes inherited from dynamicgraph::Entity
CommandMap_t commandMap
 
Logger logger_
 
std::string name
 
SignalMap signalMap
 

Private Member Functions

 DYNAMIC_GRAPH_ENTITY_DECL ()
 

Additional Inherited Members

- Public Types inherited from dynamicgraph::Entity
typedef std::map< const std::string, command::Command * > CommandMap_t
 
typedef std::map< std::string, SignalBase< sigtime_t > * > SignalMap
 

Detailed Description

Definition at line 25 of file oscillator.hh.

Constructor & Destructor Documentation

◆ Oscillator()

dynamicgraph::sot::tools::Oscillator::Oscillator ( const std::string  name)

epsilon is used to ensure there is no discontinuity when starting or stopping the oscillator. It defines the sensitivity to discontinuities

Definition at line 22 of file oscillator.cc.

Member Function Documentation

◆ computeSignal()

double & dynamicgraph::sot::tools::Oscillator::computeSignal ( double sout,
const sigtime_t t 
)
protected

Definition at line 113 of file oscillator.cc.

◆ computeVectorSignal()

dynamicgraph::Vector & dynamicgraph::sot::tools::Oscillator::computeVectorSignal ( dynamicgraph::Vector vsout,
const sigtime_t t 
)
protected

Definition at line 106 of file oscillator.cc.

◆ DYNAMIC_GRAPH_ENTITY_DECL()

dynamicgraph::sot::tools::Oscillator::DYNAMIC_GRAPH_ENTITY_DECL ( )
private

◆ value()

double dynamicgraph::sot::tools::Oscillator::value ( double  dt,
double  time,
double  omega,
double  phase,
double  amplitude,
double  bias 
)
protected

Definition at line 100 of file oscillator.cc.

Member Data Documentation

◆ angularFrequencySIN_

SignalPtr<double, sigtime_t> dynamicgraph::sot::tools::Oscillator::angularFrequencySIN_
protected

Definition at line 38 of file oscillator.hh.

◆ biasSIN_

SignalPtr<double, sigtime_t> dynamicgraph::sot::tools::Oscillator::biasSIN_
protected

Definition at line 41 of file oscillator.hh.

◆ continuous_

bool dynamicgraph::sot::tools::Oscillator::continuous_
protected

Definition at line 47 of file oscillator.hh.

◆ dt_

double dynamicgraph::sot::tools::Oscillator::dt_
protected

Definition at line 48 of file oscillator.hh.

◆ epsilon_

double dynamicgraph::sot::tools::Oscillator::epsilon_
protected

Definition at line 45 of file oscillator.hh.

◆ lastValue_

double dynamicgraph::sot::tools::Oscillator::lastValue_
protected

Definition at line 49 of file oscillator.hh.

◆ magnitudeSIN_

SignalPtr<double, sigtime_t> dynamicgraph::sot::tools::Oscillator::magnitudeSIN_
protected

Definition at line 39 of file oscillator.hh.

◆ phaseSIN_

SignalPtr<double, sigtime_t> dynamicgraph::sot::tools::Oscillator::phaseSIN_
protected

Definition at line 40 of file oscillator.hh.

◆ soutSOUT_

SignalTimeDependent<double, sigtime_t> dynamicgraph::sot::tools::Oscillator::soutSOUT_
protected

Definition at line 42 of file oscillator.hh.

◆ started_

bool dynamicgraph::sot::tools::Oscillator::started_
protected

Definition at line 46 of file oscillator.hh.

◆ vectorSoutSOUT_

SignalTimeDependent<dynamicgraph::Vector, sigtime_t> dynamicgraph::sot::tools::Oscillator::vectorSoutSOUT_
protected

Definition at line 43 of file oscillator.hh.


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


sot-tools
Author(s): Mehdi Benallegue, Francois Keith, Florent Lamiraux, Thomas Moulard, Olivier Stasse, Jorrit T'Hooft
autogenerated on Wed Aug 2 2023 02:35:13