agxData::FrameTranspose Class Reference

#include <FrameTranspose.h>

Inheritance diagram for agxData::FrameTranspose:

Public Types
typedef agx::observer_ptr< const AttributeTrack >	AttributeTrackConstObserver
typedef agx::ref_ptr< const AttributeTrack >	AttributeTrackConstRef
typedef agx::observer_ptr< AttributeTrack >	AttributeTrackObserver
typedef agx::ref_ptr< AttributeTrack >	AttributeTrackRef
typedef agx::observer_ptr< const Track >	TrackConstObserver
typedef agx::ref_ptr< const Track >	TrackConstRef
typedef agx::observer_ptr< Track >	TrackObserver
typedef agx::Vector< TrackObserver >	TrackObserverVector
typedef agx::VectorPOD< Track * >	TrackPtrVector
typedef agx::ref_ptr< Track >	TrackRef
typedef agx::Vector< TrackRef >	TrackRefVector
typedef agx::observer_ptr< const ValueTrack >	ValueTrackConstObserver
typedef agx::ref_ptr< const ValueTrack >	ValueTrackConstRef
typedef agx::observer_ptr< ValueTrack >	ValueTrackObserver
typedef agx::ref_ptr< ValueTrack >	ValueTrackRef
Public Types inherited from agxData::FrameWriter
typedef agx::Event1< const Frame * >	WriteEvent
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
	FrameTranspose (agxData::JournalArchive::Session *session)
	FrameTranspose (bool active=true)
	AttributeTrack (const agx::Path &storagePath, const agx::Name &attributeName, agx::Index instanceId)
void	extractFrames ()
	Extract all frames from track.
void	extractFrames (agx::RangeReal timeRange)
	Extract all frames from track within a time range.
const agx::Name &	getAttributeName () const
agxData::Buffer *	getData ()
const agxData::Buffer *	getData () const
const agx::Path &	getDataPath () const
agxData::Buffer *	getIndexTrack ()
const agxData::Buffer *	getIndexTrack () const
agx::Index	getInstanceId () const
const agx::Path &	getStoragePath () const
agx::RangeReal	getTimeRange () const
agxData::Buffer *	getTimeTrack ()
const agxData::Buffer *	getTimeTrack () const
const TrackRefVector &	getTracks () const
AttributeTrack *	registerTrack (const agx::Path &storagePath, const agx::Name &attributeName, agx::Index instanceId)
ValueTrack *	registerTrack (const agx::Path &valuePath)
void	registerTrack (Track *track)
	Register a track to be filled with transpose data.
void	setFrameStride (agx::UInt stride)
	Track ()
	Track (const agx::Path &dataPath)
	ValueTrack (const agx::Path &valuePath)
Public Member Functions inherited from agxData::FrameWriter
	FrameWriter (bool active)
virtual void	endOfStream ()
virtual void	forceFlush ()
agx::UInt	getNumWrittenFrames () const
bool	isEOF () const
virtual void	writeFrame (const Frame *frame)=0
	Export a frame the implementation-specific format.
Public Member Functions inherited from agxData::FrameIO
void	addDataBinding (const agx::Path &internalPath, const agx::Path &externalPath, bool recursive=false)
	Register a data binding.
void	addDataBinding (const agx::Path &path, bool recursive=false)
	Alias for addDataBinding(path, path)
void	clearDataBindings ()
	Remove all data bindings.
const Frame::DataBindingRefVector &	getDataBindings () const
SerializedFrame::HeaderFormat	getHeaderFormat () const
Track *	getTrack ()
const Track *	getTrack () const
bool	isActive () const
void	loadDataBindings (const agx::String &xmlFilePath)
	Load bindings from an xml file.
bool	loadDataBindingsJSON (const agx::String &jsonFilePath)
bool	removeDataBinding (const agx::Path &internalPath, const agx::Path &externalPath)
bool	removeDataBinding (const agx::Path &path)
void	setHeaderFormat (SerializedFrame::HeaderFormat format)
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	~AttributeTrack ()
virtual	~FrameTranspose ()
virtual	~Track ()
virtual	~ValueTrack ()
virtual Frame::DataBinding *	createDataBinding (const agx::Path &internalPath, const agx::Path &externalPath)
virtual void	writeFrame (const Frame *frame)
	Export a frame the implementation-specific format.
Protected Member Functions inherited from agxData::FrameWriter
virtual	~FrameWriter ()
Protected Member Functions inherited from agxData::FrameIO
	FrameIO (bool active)
virtual	~FrameIO ()
void	addDataBinding (Frame::DataBinding *binding)
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
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 agxData::FrameWriter
WriteEvent	writeEvent
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 agxData::FrameWriter
agx::UInt	m_numWrittenFrames
Protected Attributes inherited from agx::Referenced
Mutex	m_mutex
ObserverContainer	m_observers
AtomicValue	m_refCount

Detailed Description

Definition at line 28 of file FrameTranspose.h.

Member Typedef Documentation

AttributeTrackConstObserver

typedef agx::observer_ptr< const AttributeTrack > agxData::FrameTranspose::AttributeTrackConstObserver

Definition at line 34 of file FrameTranspose.h.

AttributeTrackConstRef

typedef agx::ref_ptr< const AttributeTrack > agxData::FrameTranspose::AttributeTrackConstRef

Definition at line 34 of file FrameTranspose.h.

AttributeTrackObserver

typedef agx::observer_ptr< AttributeTrack > agxData::FrameTranspose::AttributeTrackObserver

Definition at line 34 of file FrameTranspose.h.

AttributeTrackRef

typedef agx::ref_ptr< AttributeTrack > agxData::FrameTranspose::AttributeTrackRef

Definition at line 34 of file FrameTranspose.h.

TrackConstObserver

typedef agx::observer_ptr< const Track > agxData::FrameTranspose::TrackConstObserver

Definition at line 31 of file FrameTranspose.h.

TrackConstRef

typedef agx::ref_ptr< const Track > agxData::FrameTranspose::TrackConstRef

Definition at line 31 of file FrameTranspose.h.

TrackObserver

typedef agx::observer_ptr< Track > agxData::FrameTranspose::TrackObserver

Definition at line 31 of file FrameTranspose.h.

TrackObserverVector

typedef agx::Vector< TrackObserver> agxData::FrameTranspose::TrackObserverVector

Definition at line 32 of file FrameTranspose.h.

TrackPtrVector

typedef agx::VectorPOD< Track *> agxData::FrameTranspose::TrackPtrVector

Definition at line 32 of file FrameTranspose.h.

TrackRef

typedef agx::ref_ptr< Track > agxData::FrameTranspose::TrackRef

Definition at line 31 of file FrameTranspose.h.

TrackRefVector

typedef agx::Vector< TrackRef> agxData::FrameTranspose::TrackRefVector

Definition at line 32 of file FrameTranspose.h.

ValueTrackConstObserver

typedef agx::observer_ptr< const ValueTrack > agxData::FrameTranspose::ValueTrackConstObserver

Definition at line 35 of file FrameTranspose.h.

ValueTrackConstRef

typedef agx::ref_ptr< const ValueTrack > agxData::FrameTranspose::ValueTrackConstRef

Definition at line 35 of file FrameTranspose.h.

ValueTrackObserver

typedef agx::observer_ptr< ValueTrack > agxData::FrameTranspose::ValueTrackObserver

Definition at line 35 of file FrameTranspose.h.

ValueTrackRef

typedef agx::ref_ptr< ValueTrack > agxData::FrameTranspose::ValueTrackRef

Definition at line 35 of file FrameTranspose.h.

Constructor & Destructor Documentation

FrameTranspose() [1/2]

agxData::FrameTranspose::FrameTranspose

(

bool

active = true

)

FrameTranspose() [2/2]

agxData::FrameTranspose::FrameTranspose

(

agxData::JournalArchive::Session *

session

)

~FrameTranspose()

virtual agxData::FrameTranspose::~FrameTranspose ( )

protectedvirtual

~Track()

virtual agxData::FrameTranspose::~Track ( )

protectedvirtual

~AttributeTrack()

virtual agxData::FrameTranspose::~AttributeTrack ( )

protectedvirtual

~ValueTrack()

virtual agxData::FrameTranspose::~ValueTrack ( )

protectedvirtual

Member Function Documentation

AttributeTrack()

agxData::FrameTranspose::AttributeTrack	(	const agx::Path &	storagePath,
		const agx::Name &	attributeName,
		agx::Index	instanceId
	)

createDataBinding()

virtual Frame::DataBinding * agxData::FrameTranspose::createDataBinding ( const agx::Path &  internalPath, const agx::Path &  externalPath  )

protectedvirtual

Reimplemented from agxData::FrameIO.

extractFrames() [1/2]

void agxData::FrameTranspose::extractFrames

(

)

Extract all frames from track.

Assumes EOF is reached at some point. Must not be called if FrameTranspose is created as non-active.

extractFrames() [2/2]

void agxData::FrameTranspose::extractFrames

(

agx::RangeReal

timeRange

)

Extract all frames from track within a time range.

Assumes EOF is reached at some point. Must not be called if FrameTranspose is created as non-active.

Parameters

timeRange

- Range of simulation time (in seconds)

getAttributeName()

const agx::Name & agxData::FrameTranspose::getAttributeName

(

)

const

getData() [1/2]

agxData::Buffer * agxData::FrameTranspose::getData

(

)

Returns

The track data values.

getData() [2/2]

const agxData::Buffer * agxData::FrameTranspose::getData

(

)

const

Returns

The track data values.

getDataPath()

const agx::Path & agxData::FrameTranspose::getDataPath

(

)

const

Returns

The data path.

getIndexTrack() [1/2]

agxData::Buffer * agxData::FrameTranspose::getIndexTrack

(

)

Returns

The index track, which is automatically registered

getIndexTrack() [2/2]

const agxData::Buffer * agxData::FrameTranspose::getIndexTrack

(

)

const

getInstanceId()

agx::Index agxData::FrameTranspose::getInstanceId

(

)

const

getStoragePath()

const agx::Path & agxData::FrameTranspose::getStoragePath

(

)

const

getTimeRange()

agx::RangeReal agxData::FrameTranspose::getTimeRange

(

)

const

Returns

The time range for the track.

getTimeTrack() [1/2]

agxData::Buffer * agxData::FrameTranspose::getTimeTrack

(

)

Returns

The time track, which is automatically registered

getTimeTrack() [2/2]

const agxData::Buffer * agxData::FrameTranspose::getTimeTrack

(

)

const

getTracks()

const TrackRefVector & agxData::FrameTranspose::getTracks

(

)

const

Returns

The registered track

registerTrack() [1/3]

AttributeTrack * agxData::FrameTranspose::registerTrack	(	const agx::Path &	storagePath,
		const agx::Name &	attributeName,
		agx::Index	instanceId
	)

registerTrack() [2/3]

ValueTrack * agxData::FrameTranspose::registerTrack

(

const agx::Path &

valuePath

)

registerTrack() [3/3]

void agxData::FrameTranspose::registerTrack

(

Track *

track

)

Register a track to be filled with transpose data.

setFrameStride()

void agxData::FrameTranspose::setFrameStride

(

agx::UInt

stride

)

Track() [1/2]

agxData::FrameTranspose::Track

(

)

Track() [2/2]

agxData::FrameTranspose::Track

(

const agx::Path &

dataPath

)

ValueTrack()

agxData::FrameTranspose::ValueTrack

(

const agx::Path &

valuePath

)

writeFrame()

virtual void agxData::FrameTranspose::writeFrame ( const Frame *  frame )

protectedvirtual

Export a frame the implementation-specific format.

Implements agxData::FrameWriter.

---

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

• FrameTranspose.h