AGX Dynamics 2.42.3.0
Loading...
Searching...
No Matches
agx::Stream Class Reference

TODO: Documentation. More...

#include <Stream.h>

+ Inheritance diagram for agx::Stream:

Public Types

typedef agx::observer_ptr< const DataEvent > DataEventConstObserver
 
typedef agx::ref_ptr< const DataEvent > DataEventConstRef
 
typedef agx::observer_ptr< DataEvent > DataEventObserver
 
typedef agx::ref_ptr< DataEvent > DataEventRef
 
typedef agx::observer_ptr< const Event > EventConstObserver
 
typedef agx::ref_ptr< const Event > EventConstRef
 
typedef agx::observer_ptr< Event > EventObserver
 
typedef agx::ref_ptr< Event > EventRef
 
typedef agx::observer_ptr< const FunctionEvent > FunctionEventConstObserver
 
typedef agx::ref_ptr< const FunctionEvent > FunctionEventConstRef
 
typedef agx::observer_ptr< FunctionEvent > FunctionEventObserver
 
typedef agx::ref_ptr< FunctionEvent > FunctionEventRef
 
- Public Types inherited from agx::Object
typedef agx::observer_ptr< const Event > EventConstObserver
 
typedef agx::ref_ptr< const Event > EventConstRef
 
typedef agx::observer_ptr< Event > EventObserver
 
typedef agx::Vector< EventObserver > EventObserverVector
 
typedef agx::VectorPOD< Event * > EventPtrVector
 
typedef agx::ref_ptr< Event > EventRef
 
typedef agx::Vector< EventRef > EventRefVector
 

Public Member Functions

void evaluate ()
 eg 'Add'
 
 Event ()
 
 FunctionEvent (agx::Model *kernelModel)
 
 FunctionEvent (const agxNet::StructuredMessage *message)
 
const Object * getParameter (const Name &name) const
 TODO: Common baseclass, agxData::Value -> agx::Scalar, agx::Buffer (agx::Buffer -> agx::Array<T> ?)
 
- Public Member Functions inherited from agx::Object
 Object (const Name &name=Name(), Model *model=Object::ClassModel())
 
void addListener (EventListener *listener)
 
virtual void buildNavigationTree (agxJson::Value &eNode) const
 
virtual void configure (TiXmlElement *)
 
agx::String fullName () const
 
agx::String fullPath () const
 
agx::String fullPath (const agx::Object *root) const
 
template<typename T >
T * getAutoScopedResource (const agx::Path &path)
 
template<typename T >
const T * getAutoScopedResource (const agx::Path &path) const
 
agx::Object * getAutoScopedResource (const agx::Path &path, agx::Model *model=nullptr)
 
const agx::Object * getAutoScopedResource (const agx::Path &path, agx::Model *model=nullptr) const
 
agx::Object * getContext ()
 
template<typename T >
T * getContext ()
 
const agx::Object * getContext () const
 
template<typename T >
const T * getContext () const
 
agx::UInt32 getId () const
 
const agx::Name & getImplementationName () const
 
agx::Model * getModel ()
 
const agx::Model * getModel () const
 
const agx::Name & getName () const
 
agx::Object * getNextSibling ()
 
const agx::Object * getNextSibling () const
 
agx::Path getPath () const
 
agx::Path getPath (const agx::Object *root) const
 
template<typename T >
T * getResource (const agx::Path &path)
 
template<typename T >
const T * getResource (const agx::Path &path) const
 
agx::Object * getResource (const agx::Path &path, agx::Model *model=nullptr)
 
const agx::Object * getResource (const agx::Path &path, agx::Model *model=nullptr) const
 
virtual agx::Object * getResourceImpl (const agx::Path &path, agx::Model *model)
 
agx::Object * getRootContext ()
 
const agx::Object * getRootContext () const
 
bool hasListener (EventListener *listener)
 
bool hasParent (const agx::Object *node) const
 
bool isUnique () const
 
virtual void printSubtree () const
 
virtual void rebind ()
 
void removeListener (EventListener *listener)
 
virtual void save (TiXmlElement *) const
 
virtual void setContext (agx::Object *context)
 
void setId (UInt32 id)
 
void setModel (agx::Model *model)
 Set the object model (handled automatically).
 
void setName (const agx::Name &name)
 Set the name of the object.
 
virtual void snapshot (TiXmlNode *, const String &) const
 
- 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 Member Functions

virtual ~Event ()
 
virtual void setup ()
 
- Protected Member Functions inherited from agx::Object
virtual ~Object ()
 
- Protected Member Functions inherited from agx::Referenced
virtual ~Referenced ()
 Destructor.
 
void allocateObserverVector () const
 
void deleteUsingDeleteHandler () const
 

Protected Attributes

agx::EventModelRef m_model
 
- 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::Object
static agx::Model * ClassModel ()
 
static agx::String generateName (const agx::String &bindPath)
 
static const HashSet< Object * > & getActiveObjects ()
 
static bool getEnableRebind ()
 Should rebinding be allowed? Right now a global setting.
 
static Object * load (const String &path, Device *device, const String &type, const String &attribute, const String &value)
 
template<typename T >
static T * load (const String &path, Device *device, const String &type, const String &attribute, const String &value)
 
static Object * load (const String &path, Device *device, const String &type="", size_t instance=0)
 
template<typename T >
static T * load (const String &path, Device *device, const String &type="", size_t instance=0)
 
static void load (const String &path, Device *device, ObjectPtrVector &loadedObjects)
 
static Object * load (TiXmlElement *eObject, Device *device)
 
template<typename T >
static T * load (TiXmlElement *eObject, Device *device)
 
static TiXmlDocument openDocument (const String &path)
 
static void setEnableRebind (bool flag)
 Sets if rebinding of objects should be allowed (Right now a global setting).
 
- Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool ValidateCast (const Referenced *object)
 
- 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

TODO: Documentation.

Definition at line 49 of file Stream.h.

Member Typedef Documentation

◆ DataEventConstObserver

Definition at line 53 of file Stream.h.

◆ DataEventConstRef

typedef agx::ref_ptr< const DataEvent > agx::Stream::DataEventConstRef

Definition at line 53 of file Stream.h.

◆ DataEventObserver

Definition at line 53 of file Stream.h.

◆ DataEventRef

Definition at line 53 of file Stream.h.

◆ EventConstObserver

Definition at line 52 of file Stream.h.

◆ EventConstRef

Definition at line 52 of file Stream.h.

◆ EventObserver

Definition at line 52 of file Stream.h.

◆ EventRef

Definition at line 52 of file Stream.h.

◆ FunctionEventConstObserver

◆ FunctionEventConstRef

Definition at line 54 of file Stream.h.

◆ FunctionEventObserver

◆ FunctionEventRef

Definition at line 54 of file Stream.h.

Constructor & Destructor Documentation

◆ ~Event()

virtual agx::Stream::~Event ( )
protectedvirtual

Member Function Documentation

◆ evaluate()

void agx::Stream::evaluate ( )

eg 'Add'

eg. 'Math.Add', should return agx::Path? Evaluate the function with the registered parameters.

◆ Event()

◆ FunctionEvent() [1/2]

agx::Stream::FunctionEvent ( agx::Model *  kernelModel)

◆ FunctionEvent() [2/2]

agx::Stream::FunctionEvent ( const agxNet::StructuredMessage *  message)

◆ getParameter()

const Object * agx::Stream::getParameter ( const Name &  name) const

TODO: Common baseclass, agxData::Value -> agx::Scalar, agx::Buffer (agx::Buffer -> agx::Array<T> ?)

◆ setup()

virtual void agx::Stream::setup ( )
inlineprotectedvirtual

Definition at line 135 of file Stream.h.

Member Data Documentation

◆ m_model

agx::EventModelRef agx::Stream::m_model
protected

Definition at line 78 of file Stream.h.


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