agxData::Track::Thread Class Reference

#include <Track.h>

Inheritance diagram for agxData::Track::Thread:

Public Member Functions
	Thread (Track *track, agx::Callback entryPoint, const agx::Name &="Thread")
void	activate ()
	Activate the thread.
void	deactivate ()
	Deactivate the thread.
Track *	getTrack ()
bool	isActive () const
bool	isRunning () const
void	start (bool activate=true)
	Start the thread, and optionally activate it.
void	stop ()
	Stop the thread.
Public Member Functions inherited from agx::BasicThread
	BasicThread ()
	Default constructor.
	BasicThread (const BasicThread &other)=delete
virtual	~BasicThread ()=default
	Destructor.
void	cancel ()
	Threads should normally not need to be killed.
void	detach ()
	Detaches the thread to the background.
unsigned int	getThreadState ()
	Returns the current thread state.
bool	join ()
	Joins the thread.
bool	joinable ()
	True if thread is joinable.
BasicThread &	operator= (const BasicThread &rhs)=delete
virtual void	run ()
	This method is invoked by start.
bool	setThreadAffinity (agx::UInt64 cpumask)
	Thread Affinity can be used to influence on which logical cores threads are scheduled and allowed to run.
bool	start ()
	Launches the thread.
Public Member Functions inherited from agx::Component
	Component (const agx::Name &name=agx::Name(), agx::Model *model=agx::Component::ClassModel(), agx::Device *device=nullptr)
virtual void	addObject (agx::Object *object, bool assignContext=true)
	Add an object to the component.
virtual String	autoComplete (const String &partialName, StringVector &matchingNames) const
virtual void	buildNavigationTree (agxJson::Value &eNode) const override
void	configure (Model *model)
virtual void	configure (TiXmlElement *eComponent) override
agx::Device *	getDevice ()
template<typename T >
T *	getDevice ()
const agx::Device *	getDevice () const
template<typename T >
const T *	getDevice () const
size_t	getNumObjects (const agx::Name &name) const
agx::Object *	getObject (const agx::Name &name, agx::Model *model, size_t index=0)
const agx::Object *	getObject (const agx::Name &name, agx::Model *model, size_t index=0) const
agx::Object *	getObject (const agx::Name &name, size_t index=0)
template<typename T >
T *	getObject (const agx::Name &name, size_t index=0)
const agx::Object *	getObject (const agx::Name &name, size_t index=0) const
template<typename T >
const T *	getObject (const agx::Name &name, size_t index=0) const
const agx::ObjectRefVector &	getObjects () const
template<typename T >
void	getObjects (agx::ObjectPtrVector &result, bool recursive=false) const
	Returns All child objects of a specified type in the result container.
void	getObjects (agx::ObjectPtrVector &result, const agx::Model *model, bool recursive=false) const
virtual Object *	getResourceImpl (const Path &path, agx::Model *model) override
virtual void	printSubtree () const override
void	printSubtree (std::ostream &stream, int depth=0) const
virtual void	rebind () override
void	removeAllObjects ()
	Remove all components.
virtual void	removeObject (agx::Object *object)
	Remove an object from the component.
void	removeObject (const agx::Name &name, size_t index=0)
	Remove an object with a specified name (and optional index) from the component.
virtual void	snapshot (TiXmlNode *eParent, const String &directory) const override
void	traverse (ComponentVisitor *)
void	traverse (const TraverseCallback &callback)
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	~Thread ()
Protected Member Functions inherited from agx::Component
virtual	~Component ()
String	expandAutoCompletionMatch (const String &query, const StringVector &matchingNames) const
void	setDevice (Device *device)
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

Additional Inherited Members
Public Types inherited from agx::BasicThread
enum	ThreadState {   THREAD_NEW = 0 , THREAD_RUNNING = 1 , THREAD_DETACHED = 2 , THREAD_DONE = 3 ,   THREAD_JOINED = 4 , THREAD_CANCELLED = 5 }
	States for the thread. More...
Public Types inherited from agx::Component
typedef Event2< Component *, Object * >	ObjectEvent
	Event when adding removing child objects.
typedef Callback1< Object * >	TraverseCallback
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
Static Public Member Functions inherited from agx::BasicThread
static std::thread::native_handle_type	getCurrentThreadHandle ()
	Return a native_handle for the current executing thread.
Static Public Member Functions inherited from agx::Component
static Component *	_load (TiXmlElement *eComponent, Device *device)
static agx::Model *	ClassModel ()
static Component *	load (const Path &path, const Name &implementation, Device *device, const Path &_namespace=Path())
static Component *	load (const String &path, const Path &_namespace=Path())
static Component *	load (const String &path, Device *device, const Path &_namespace=Path())
static Component *	load (TiXmlElement *eComponent, Device *device)
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)
Public Attributes inherited from agx::Component
ObjectEvent	addObjectEvent
ObjectEvent	removeObjectEvent
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::BasicThread
std::thread	m_handle
std::atomic< unsigned int >	m_state
Protected Attributes inherited from agx::Referenced
Mutex	m_mutex
ObserverContainer	m_observers
AtomicValue	m_refCount

Detailed Description

Definition at line 369 of file agxData/Track.h.

Constructor & Destructor Documentation

Thread()

agxData::Track::Thread::Thread	(	Track *	track,
		agx::Callback	entryPoint,
		const agx::Name &	= "Thread"
	)

~Thread()

virtual agxData::Track::Thread::~Thread ( )

protectedvirtual

Member Function Documentation

activate()

void agxData::Track::Thread::activate

(

)

Activate the thread.

Thread state progression: stopped -> started -> [active -> inactive]* -> stopped In the sleeping state the OS thread is still running but inactivated by a semaphore. This to enable fast activation irregardless of OS implementation.

deactivate()

void agxData::Track::Thread::deactivate

(

)

Deactivate the thread.

getTrack()

Track * agxData::Track::Thread::getTrack ( )

inline

Definition at line 407 of file agxData/Track.h.

isActive()

bool agxData::Track::Thread::isActive

(

)

const

Returns

True if active.

Definition at line 477 of file agxData/Track.h.

isRunning()

bool agxData::Track::Thread::isRunning

(

)

const

Returns

True if the thread is running.

Definition at line 476 of file agxData/Track.h.

start()

void agxData::Track::Thread::start

(

bool

activate = true

)

Start the thread, and optionally activate it.

stop()

void agxData::Track::Thread::stop

(

)

Stop the thread.

---

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

• agxData/Track.h