AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agxSDK::SimulationControlArgument Class Referenceabstract

Base class for input/output arguments. More...

#include <SimulationControl.h>

+ Inheritance diagram for agxSDK::SimulationControlArgument:

Public Member Functions

 SimulationControlArgument (size_t numInputValues, size_t numOutputValues)
 
virtual bool applyInput (const agxSDK::Simulation *simulation, const agx::RealVector &input) const =0
 
size_t getNumInputValues () const
 
size_t getNumOutputValues () const
 
virtual bool obtainOutput (const agxSDK::Simulation *simulation, const agx::RealVector &output) const =0
 
- 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.
 

Protected Attributes

size_t m_numInputValues
 
size_t m_numOutputValues
 
- Protected Attributes inherited from agx::Referenced
Mutex m_mutex
 
ObserverContainer m_observers
 
AtomicValue m_refCount
 

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.
 

Detailed Description

Base class for input/output arguments.

Definition at line 44 of file SimulationControl.h.

Constructor & Destructor Documentation

◆ SimulationControlArgument()

agxSDK::SimulationControlArgument::SimulationControlArgument ( size_t  numInputValues,
size_t  numOutputValues 
)

Member Function Documentation

◆ applyInput()

virtual bool agxSDK::SimulationControlArgument::applyInput ( const agxSDK::Simulation *  simulation,
const agx::RealVector &  input 
) const
pure virtual

◆ getNumInputValues()

size_t agxSDK::SimulationControlArgument::getNumInputValues ( ) const
Returns
number of input values

◆ getNumOutputValues()

size_t agxSDK::SimulationControlArgument::getNumOutputValues ( ) const
Returns
number of output values

◆ obtainOutput()

virtual bool agxSDK::SimulationControlArgument::obtainOutput ( const agxSDK::Simulation *  simulation,
const agx::RealVector &  output 
) const
pure virtual

Member Data Documentation

◆ m_numInputValues

size_t agxSDK::SimulationControlArgument::m_numInputValues
protected

Definition at line 59 of file SimulationControl.h.

◆ m_numOutputValues

size_t agxSDK::SimulationControlArgument::m_numOutputValues
protected

Definition at line 60 of file SimulationControl.h.


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