AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agxModel::Controller1D Class Reference

A simple base class for a controller with a set point and an out signal. More...

#include <Controller1D.h>

+ Inheritance diagram for agxModel::Controller1D:

Public Member Functions

virtual agx::Real getManipulatedVariable () const
 get the Manipulated Variable (MV)
 
virtual agx::Real getSetPoint () const
 Get the current Set Point for the controller.
 
virtual void reset ()
 Reset all calculated values to initial conditions. This will keep the Set Point.
 
virtual void setSetPoint (agx::Real)
 Set the current Set Point for the controller.
 
virtual void update (const agx::TimeStamp &, agx::Real)
 Update the measured Process Variable and calculate a new Manipulated Variable.
 
- Public Member Functions inherited from agx::Referenced
 Referenced ()
 Default constructor.
 
 Referenced (const Referenced &)
 
template<typename T >
T * as ()
 Subclass casting.
 
template<typename T >
const T * as () const
 
template<typename T >
T * asSafe ()
 Safe subclass casting, return nullptr if template type does not match.
 
template<typename T >
const T * asSafe () const
 
int getReferenceCount () const
 
template<typename T >
bool is () const
 Subclass test.
 
Referenced & operator= (const Referenced &)
 Assignment operator. Will increment the number of references to the referenced object.
 
void reference (void *ptr=nullptr) const
 Explicitly increment the reference count by one, indicating that this object has another pointer which is referencing it.
 
void unreference (void *ptr=nullptr) const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 
void unreference_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
 

Additional Inherited Members

- Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool ValidateCast (const Referenced *object)
 
- Protected Member Functions inherited from agx::Referenced
virtual ~Referenced ()
 Destructor.
 
void allocateObserverVector () const
 
void deleteUsingDeleteHandler () const
 
- Static Protected Member Functions inherited from agx::Referenced
static DeleteHandler * getDeleteHandler ()
 
static void setDeleteHandler (DeleteHandler *handler)
 Internal: Set a DeleteHandler to which deletion of all referenced counted objects will be delegated to.
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

Detailed Description

A simple base class for a controller with a set point and an out signal.

This class is not for direct use; use any of the derived classes instead, e.g. agxModel::PidController1D.

Definition at line 35 of file Controller1D.h.

Member Function Documentation

◆ getManipulatedVariable()

virtual agx::Real agxModel::Controller1D::getManipulatedVariable ( ) const
inlinevirtual

get the Manipulated Variable (MV)

Reimplemented in agxModel::PidController1D.

Definition at line 48 of file Controller1D.h.

◆ getSetPoint()

virtual agx::Real agxModel::Controller1D::getSetPoint ( ) const
inlinevirtual

Get the current Set Point for the controller.

Reimplemented in agxModel::PidController1D.

Definition at line 54 of file Controller1D.h.

◆ reset()

virtual void agxModel::Controller1D::reset ( )
inlinevirtual

Reset all calculated values to initial conditions. This will keep the Set Point.

Reimplemented in agxModel::PidController1D.

Definition at line 45 of file Controller1D.h.

◆ setSetPoint()

virtual void agxModel::Controller1D::setSetPoint ( agx::Real  )
inlinevirtual

Set the current Set Point for the controller.

Reimplemented in agxModel::PidController1D.

Definition at line 51 of file Controller1D.h.

◆ update()

virtual void agxModel::Controller1D::update ( const agx::TimeStamp &  ,
agx::Real   
)
inlinevirtual

Update the measured Process Variable and calculate a new Manipulated Variable.

The measuredProcessVariable is the Plant measured Process Variable, PV in a Control System and time is the current simulation time

Reimplemented in agxModel::PidController1D.

Definition at line 42 of file Controller1D.h.


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