Drake
LogisticWitness< T > Class Template Reference

Witness function for determining when the state of the logistic system crosses zero. More...

#include <drake/systems/analysis/test/logistic_system.h>

Inheritance diagram for LogisticWitness< T >:
[legend]
Collaboration diagram for LogisticWitness< T >:
[legend]

Public Member Functions

 ~LogisticWitness () override
 
 LogisticWitness (const LogisticSystem< T > &system)
 
- Public Member Functions inherited from WitnessFunction< T >
virtual ~WitnessFunction ()
 
 WitnessFunction (const System< T > &system, const WitnessFunctionDirection &dtype)
 Constructs the witness function with the given direction type. More...
 
const std::string & get_name () const
 Gets the name of this witness function (used primarily for logging and debugging). More...
 
void set_name (const std::string &name)
 Sets the name of this witness function. More...
 
void AddEvent (CompositeEventCollection< T > *events) const
 Adds the appropriate event that will be dispatched when this witness function triggers. More...
 
WitnessFunctionDirection get_dir_type () const
 Gets the direction(s) under which this witness function triggers. More...
 
Evaluate (const Context< T > &context) const
 Evaluates the witness function at the given context. More...
 
const System< T > & get_system () const
 Gets a reference to the System used by this witness function. More...
 
decltype(T()< T()) should_trigger (const T &w0, const T &wf) const
 Checks whether the witness function should trigger using given values at w0 and wf. More...
 
 WitnessFunction (const WitnessFunction &)=delete
 
WitnessFunctionoperator= (const WitnessFunction &)=delete
 
 WitnessFunction (WitnessFunction &&)=delete
 
WitnessFunctionoperator= (WitnessFunction &&)=delete
 

Protected Member Functions

void DoAddEvent (systems::CompositeEventCollection< T > *events) const override
 
DoEvaluate (const Context< T > &context) const override
 Derived classes will implement this function to evaluate the witness function at the given context. More...
 
- Protected Member Functions inherited from WitnessFunction< T >
virtual void DoAddEvent (CompositeEventCollection< T > *events) const =0
 Derived classes will override this function to add the appropriate event that will be dispatched when this witness function triggers. More...
 

Additional Inherited Members

- Protected Attributes inherited from WitnessFunction< T >
std::string name_
 

Detailed Description

template<class T>
class drake::systems::analysis_test::LogisticWitness< T >

Witness function for determining when the state of the logistic system crosses zero.

Constructor & Destructor Documentation

~LogisticWitness ( )
inlineoverride
LogisticWitness ( const LogisticSystem< T > &  system)
inlineexplicit

Member Function Documentation

void DoAddEvent ( systems::CompositeEventCollection< T > *  events) const
inlineoverrideprotected

Here is the call graph for this function:

T DoEvaluate ( const Context< T > &  context) const
inlineoverrideprotectedvirtual

Derived classes will implement this function to evaluate the witness function at the given context.

Parameters
contextan already-validated Context

Implements WitnessFunction< T >.

Here is the call graph for this function:


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