#include <SerializedFrame.h>

Inheritance diagram for agxData::SerializedFrame:

Classes
struct	BinaryHeader

struct	BinarySegment

struct	JsonHeader

struct	XmlHeader

Public Types
typedef agx::Vector< BinarySegment >	BinarySegmentVector

typedef agx::observer_ptr< const Buffer >	BufferConstObserver

typedef agx::ref_ptr< const Buffer >	BufferConstRef

typedef agx::observer_ptr< Buffer >	BufferObserver

typedef agx::ref_ptr< Buffer >	BufferRef

typedef agx::observer_ptr< const Component >	ComponentConstObserver

typedef agx::ref_ptr< const Component >	ComponentConstRef

typedef agx::observer_ptr< Component >	ComponentObserver

typedef agx::ref_ptr< Component >	ComponentRef

typedef agx::observer_ptr< const CustomBuffer >	CustomBufferConstObserver

typedef agx::ref_ptr< const CustomBuffer >	CustomBufferConstRef

typedef agx::observer_ptr< CustomBuffer >	CustomBufferObserver

typedef agx::ref_ptr< CustomBuffer >	CustomBufferRef

typedef agx::observer_ptr< const DataNode >	DataNodeConstObserver

typedef agx::ref_ptr< const DataNode >	DataNodeConstRef

typedef agx::observer_ptr< DataNode >	DataNodeObserver

typedef agx::ref_ptr< DataNode >	DataNodeRef

typedef agx::observer_ptr< const EntityStorage >	EntityStorageConstObserver

typedef agx::ref_ptr< const EntityStorage >	EntityStorageConstRef

typedef agx::observer_ptr< EntityStorage >	EntityStorageObserver

typedef agx::ref_ptr< EntityStorage >	EntityStorageRef

typedef agx::HashVector< agx::Name, agx::UInt32 >	ExportNameTable

enum	HeaderFormat { INVALID =-1 , XML_HEADER , JSON_HEADER , BINARY_HEADER }

typedef agx::HashVector< agx::UInt32, agx::Name >	ImportNameTable

typedef agx::observer_ptr< const Node >	NodeConstObserver

typedef agx::ref_ptr< const Node >	NodeConstRef

typedef agx::observer_ptr< Node >	NodeObserver

typedef agx::Vector< NodeObserver >	NodeObserverVector

typedef agx::VectorPOD< Node * >	NodePtrVector

typedef agx::ref_ptr< Node >	NodeRef

typedef agx::Vector< NodeRef >	NodeRefVector

typedef agx::observer_ptr< const PartialBuffer >	PartialBufferConstObserver

typedef agx::ref_ptr< const PartialBuffer >	PartialBufferConstRef

typedef agx::observer_ptr< PartialBuffer >	PartialBufferObserver

typedef agx::ref_ptr< PartialBuffer >	PartialBufferRef

typedef agx::observer_ptr< const StorageBatchEvent >	StorageBatchEventConstObserver

typedef agx::ref_ptr< const StorageBatchEvent >	StorageBatchEventConstRef

typedef agx::observer_ptr< StorageBatchEvent >	StorageBatchEventObserver

typedef agx::ref_ptr< StorageBatchEvent >	StorageBatchEventRef

enum	Type { CREATE , DESTROY , PERMUTE , INVALID =-1 , VALUE , BUFFER , COMPONENT , CUSTOM_BUFFER , PARTIAL_BUFFER , ENTITY_STORAGE }

enum	Type { CREATE , DESTROY , PERMUTE , INVALID =-1 , VALUE , BUFFER , COMPONENT , CUSTOM_BUFFER , PARTIAL_BUFFER , ENTITY_STORAGE }

typedef agx::observer_ptr< const Value >	ValueConstObserver

typedef agx::ref_ptr< const Value >	ValueConstRef

typedef agx::observer_ptr< Value >	ValueObserver

typedef agx::ref_ptr< Value >	ValueRef

Public Member Functions
	SerializedFrame (const agxData::Frame *frame)

	SerializedFrame (SerializedFrame::Component *root)

void	add (agx::UInt64 id)

void	add (agxData::Array< agx::Index > &instances)

void	add (agxData::Array< agxData::EntityPtr > &instances)

void	add (agxData::EntityRange &instances)

void	addChild (Node *child)

	Buffer (const agx::Name &name, agx::Index id, BinaryData data, const Format format, size_t numElements, size_t byteOffset)

size_t	capacity () const

	Component (const agx::Name &name, agx::Index id=agx::InvalidIndex)

	CustomBuffer (const agx::Name &name, agx::Index id, const Format *format, size_t numElements)

	DataNode (const agx::Name &name, agx::Index id, BinaryData data, const Format format, size_t numBytes, size_t offset)

	EntityStorage (const agx::Name &name, agx::Index id, EntityModel *model, size_t numElements, size_t capacity)

	EntityStorage (const agxData::Frame::EntityStorage *storage)

size_t	fullSize () const

virtual size_t	getBinaryHeaderNumBytes () const =0

virtual size_t	getBinaryHeaderNumBytes () const override

virtual size_t	getBinaryHeaderNumBytes () const override

virtual size_t	getBinaryHeaderNumBytes () const override

virtual size_t	getBinaryHeaderNumBytes () const override

virtual size_t	getBinaryHeaderNumBytes () const override

virtual size_t	getBinaryHeaderNumBytes () const override

const BinarySegmentVector &	getBinarySegments () const

template<typename T >
T *	getChild (const char *name)

template<typename T >
const T *	getChild (const char *name) const

const NodeRefVector &	getChildren () const

BinaryData *	getData ()

const BinaryData *	getData () const

const Format *	getFormat () const

const Format *	getFormat () const

const Format *	getFormat () const

agx::Index	getId () const

const agx::UInt64Vector &	getIdVector () const

EntityModel *	getModel ()

const EntityModel *	getModel () const

const agx::Name &	getName () const

size_t	getNumBytes () const

size_t	getNumElements () const

size_t	getNumElements () const

size_t	getNumElements () const

size_t	getNumElements () const

size_t	getOffset () const

Component *	getParent ()

agx::String	getPath () const

Component *	getRoot ()

agxData::EntityStorage *	getStorage ()

size_t	getTotNumBytes () const

Type	getType () const

Type	getType () const

const agx::Name &	getTypeName () const

	Node (const agx::Name &name, agx::Index id)

	PartialBuffer (agxData::Frame::PartialBuffer *buffer)

	PartialBuffer (const agx::Name &name, agx::Index id, const Format *format, size_t numElements, size_t fullSize)

void	setId (agx::Index id)

void	setType (Type type)

	StorageBatchEvent (Type type, agxData::EntityStorage *storage, size_t reserve=0)

	Value (const agx::Name &name, agx::Index id, BinaryData data, const Format format, size_t offset)

BinaryData *	writeBinaryHeader () const

void	writeBinaryHeader (BinaryHeader::DataNode &eNode, ExportNameTable &nameTable)

void	writeBinaryHeader (BinaryHeader::Node &eNode, ExportNameTable &nameTable)

virtual ByteStream	writeBinaryHeader (ByteStream stream, ExportNameTable &nameTable)

virtual ByteStream	writeBinaryHeader (ByteStream stream, ExportNameTable &nameTable) override

virtual ByteStream	writeBinaryHeader (ByteStream stream, ExportNameTable &nameTable) override

virtual ByteStream	writeBinaryHeader (ByteStream stream, ExportNameTable &nameTable) override

virtual ByteStream	writeBinaryHeader (ByteStream stream, ExportNameTable &nameTable) override

virtual ByteStream	writeBinaryHeader (ByteStream stream, ExportNameTable &nameTable) override

virtual ByteStream	writeBinaryHeader (ByteStream stream, ExportNameTable &nameTable) override

template<typename ComponentT >
ByteStream	writeBinaryHeader (ByteStream stream, ExportNameTable &nameTable, ComponentT &eComponent)

BinaryData *	writeBinaryHeader (ExportNameTable &nameTable) const

void	writeChildren (agx::TiXmlElement *eParent)

void	writeDataSegment (std::ostream &binaryFile)

virtual void	writeDataSegment (std::ostream &binaryFile, agx::UInt64 baseOffset) override

virtual void	writeDataSegment (std::ostream &binaryFile, agx::UInt64 baseOffset) override

virtual void	writeDataSegment (std::ostream &binaryFile, agx::UInt64 baseOffset)=0

agx::TiXmlElement *	writeXmlHeader () const

virtual agx::TiXmlElement *	writeXmlHeader (agx::TiXmlElement *eParent) override

virtual agx::TiXmlElement *	writeXmlHeader (agx::TiXmlElement *eParent) override

virtual agx::TiXmlElement *	writeXmlHeader (agx::TiXmlElement *eParent) override

virtual agx::TiXmlElement *	writeXmlHeader (agx::TiXmlElement *eParent) override

virtual agx::TiXmlElement *	writeXmlHeader (agx::TiXmlElement *eParent) override

virtual agx::TiXmlElement *	writeXmlHeader (agx::TiXmlElement *eParent) override

virtual agx::TiXmlElement *	writeXmlHeader (agx::TiXmlElement *eParent)=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.

Static Public Member Functions
static Frame *	createFrame (const Component *root, agx::UInt index, agx::Real timeStamp, agx::Real timeStep)

static Frame *	extractFrame (agx::TiXmlElement eFrame, BinaryData dataSegment)

static Frame *	extractFrame (BinaryData headerSegment, BinaryData dataSegment)

static Frame *	extractFrame (BinaryData headerSegment, BinaryData dataSegment, ImportNameTable &nameTable, bool clearNameTableOnKeyFrame=true, FrameReader *frameReader=nullptr)

static void	updateNameTable (BinaryData *headerSegment, ImportNameTable &nameTable)

Static Public Member Functions inherited from agx::Referenced
template<typename T >
static bool	ValidateCast (const Referenced *object)

Static Public Attributes
static const agx::UInt64	DATA_SEGMENT_ALIGNMENT = 32

Protected Member Functions
virtual	~SerializedFrame ()

void	setParent (Component *parent)

Protected Member Functions inherited from agx::Referenced
virtual	~Referenced ()
	Destructor.

void	allocateObserverVector () const

void	deleteUsingDeleteHandler () const

Additional Inherited Members
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

Definition at line 41 of file SerializedFrame.h.

Member Typedef Documentation

◆ BinarySegmentVector

typedef agx::Vector<BinarySegment> agxData::SerializedFrame::BinarySegmentVector

Definition at line 106 of file SerializedFrame.h.

◆ BufferConstObserver

typedef agx::observer_ptr< const Buffer > agxData::SerializedFrame::BufferConstObserver

Definition at line 61 of file SerializedFrame.h.

◆ BufferConstRef

typedef agx::ref_ptr< const Buffer > agxData::SerializedFrame::BufferConstRef

Definition at line 61 of file SerializedFrame.h.

◆ BufferObserver

typedef agx::observer_ptr< Buffer > agxData::SerializedFrame::BufferObserver

Definition at line 61 of file SerializedFrame.h.

◆ BufferRef

typedef agx::ref_ptr< Buffer > agxData::SerializedFrame::BufferRef

Definition at line 61 of file SerializedFrame.h.

◆ ComponentConstObserver

typedef agx::observer_ptr< const Component > agxData::SerializedFrame::ComponentConstObserver

Definition at line 58 of file SerializedFrame.h.

◆ ComponentConstRef

typedef agx::ref_ptr< const Component > agxData::SerializedFrame::ComponentConstRef

Definition at line 58 of file SerializedFrame.h.

◆ ComponentObserver

typedef agx::observer_ptr< Component > agxData::SerializedFrame::ComponentObserver

Definition at line 58 of file SerializedFrame.h.

◆ ComponentRef

typedef agx::ref_ptr< Component > agxData::SerializedFrame::ComponentRef

Definition at line 58 of file SerializedFrame.h.

◆ CustomBufferConstObserver

typedef agx::observer_ptr< const CustomBuffer > agxData::SerializedFrame::CustomBufferConstObserver

Definition at line 62 of file SerializedFrame.h.

◆ CustomBufferConstRef

typedef agx::ref_ptr< const CustomBuffer > agxData::SerializedFrame::CustomBufferConstRef

Definition at line 62 of file SerializedFrame.h.

◆ CustomBufferObserver

typedef agx::observer_ptr< CustomBuffer > agxData::SerializedFrame::CustomBufferObserver

Definition at line 62 of file SerializedFrame.h.

◆ CustomBufferRef

typedef agx::ref_ptr< CustomBuffer > agxData::SerializedFrame::CustomBufferRef

Definition at line 62 of file SerializedFrame.h.

◆ DataNodeConstObserver

typedef agx::observer_ptr< const DataNode > agxData::SerializedFrame::DataNodeConstObserver

Definition at line 59 of file SerializedFrame.h.

◆ DataNodeConstRef

typedef agx::ref_ptr< const DataNode > agxData::SerializedFrame::DataNodeConstRef

Definition at line 59 of file SerializedFrame.h.

◆ DataNodeObserver

typedef agx::observer_ptr< DataNode > agxData::SerializedFrame::DataNodeObserver

Definition at line 59 of file SerializedFrame.h.

◆ DataNodeRef

typedef agx::ref_ptr< DataNode > agxData::SerializedFrame::DataNodeRef

Definition at line 59 of file SerializedFrame.h.

◆ EntityStorageConstObserver

typedef agx::observer_ptr< const EntityStorage > agxData::SerializedFrame::EntityStorageConstObserver

Definition at line 64 of file SerializedFrame.h.

◆ EntityStorageConstRef

typedef agx::ref_ptr< const EntityStorage > agxData::SerializedFrame::EntityStorageConstRef

Definition at line 64 of file SerializedFrame.h.

◆ EntityStorageObserver

typedef agx::observer_ptr< EntityStorage > agxData::SerializedFrame::EntityStorageObserver

Definition at line 64 of file SerializedFrame.h.

◆ EntityStorageRef

typedef agx::ref_ptr< EntityStorage > agxData::SerializedFrame::EntityStorageRef

Definition at line 64 of file SerializedFrame.h.

◆ ExportNameTable

typedef agx::HashVector<agx::Name, agx::UInt32> agxData::SerializedFrame::ExportNameTable

Definition at line 79 of file SerializedFrame.h.

◆ ImportNameTable

typedef agx::HashVector<agx::UInt32, agx::Name> agxData::SerializedFrame::ImportNameTable

Definition at line 80 of file SerializedFrame.h.

◆ NodeConstObserver

typedef agx::observer_ptr< const Node > agxData::SerializedFrame::NodeConstObserver

Definition at line 55 of file SerializedFrame.h.

◆ NodeConstRef

typedef agx::ref_ptr< const Node > agxData::SerializedFrame::NodeConstRef

Definition at line 55 of file SerializedFrame.h.

◆ NodeObserver

typedef agx::observer_ptr< Node > agxData::SerializedFrame::NodeObserver

Definition at line 55 of file SerializedFrame.h.

◆ NodeObserverVector

typedef agx::Vector< NodeObserver> agxData::SerializedFrame::NodeObserverVector

Definition at line 56 of file SerializedFrame.h.

◆ NodePtrVector

typedef agx::VectorPOD< Node *> agxData::SerializedFrame::NodePtrVector

Definition at line 56 of file SerializedFrame.h.

◆ NodeRef

typedef agx::ref_ptr< Node > agxData::SerializedFrame::NodeRef

Definition at line 55 of file SerializedFrame.h.

◆ NodeRefVector

typedef agx::Vector< NodeRef> agxData::SerializedFrame::NodeRefVector

Definition at line 56 of file SerializedFrame.h.

◆ PartialBufferConstObserver

typedef agx::observer_ptr< const PartialBuffer > agxData::SerializedFrame::PartialBufferConstObserver

Definition at line 63 of file SerializedFrame.h.

◆ PartialBufferConstRef

typedef agx::ref_ptr< const PartialBuffer > agxData::SerializedFrame::PartialBufferConstRef

Definition at line 63 of file SerializedFrame.h.

◆ PartialBufferObserver

typedef agx::observer_ptr< PartialBuffer > agxData::SerializedFrame::PartialBufferObserver

Definition at line 63 of file SerializedFrame.h.

◆ PartialBufferRef

typedef agx::ref_ptr< PartialBuffer > agxData::SerializedFrame::PartialBufferRef

Definition at line 63 of file SerializedFrame.h.

◆ StorageBatchEventConstObserver

typedef agx::observer_ptr< const StorageBatchEvent > agxData::SerializedFrame::StorageBatchEventConstObserver

Definition at line 66 of file SerializedFrame.h.

◆ StorageBatchEventConstRef

typedef agx::ref_ptr< const StorageBatchEvent > agxData::SerializedFrame::StorageBatchEventConstRef

Definition at line 66 of file SerializedFrame.h.

◆ StorageBatchEventObserver

typedef agx::observer_ptr< StorageBatchEvent > agxData::SerializedFrame::StorageBatchEventObserver

Definition at line 66 of file SerializedFrame.h.

◆ StorageBatchEventRef

typedef agx::ref_ptr< StorageBatchEvent > agxData::SerializedFrame::StorageBatchEventRef

Definition at line 66 of file SerializedFrame.h.

◆ ValueConstObserver

typedef agx::observer_ptr< const Value > agxData::SerializedFrame::ValueConstObserver

Definition at line 60 of file SerializedFrame.h.

◆ ValueConstRef

typedef agx::ref_ptr< const Value > agxData::SerializedFrame::ValueConstRef

Definition at line 60 of file SerializedFrame.h.

◆ ValueObserver

typedef agx::observer_ptr< Value > agxData::SerializedFrame::ValueObserver

Definition at line 60 of file SerializedFrame.h.

◆ ValueRef

typedef agx::ref_ptr< Value > agxData::SerializedFrame::ValueRef

Definition at line 60 of file SerializedFrame.h.

Member Enumeration Documentation

◆ HeaderFormat

enum agxData::SerializedFrame::HeaderFormat

Enumerator
INVALID
XML_HEADER
JSON_HEADER
BINARY_HEADER

Definition at line 44 of file SerializedFrame.h.

◆ Type [1/2]

enum agxData::SerializedFrame::Type

Enumerator
CREATE
DESTROY
PERMUTE
INVALID
VALUE
BUFFER
COMPONENT
CUSTOM_BUFFER
PARTIAL_BUFFER
ENTITY_STORAGE

Definition at line 169 of file SerializedFrame.h.

◆ Type [2/2]

enum agxData::SerializedFrame::Type

Enumerator
CREATE
DESTROY
PERMUTE
INVALID
VALUE
BUFFER
COMPONENT
CUSTOM_BUFFER
PARTIAL_BUFFER
ENTITY_STORAGE

Definition at line 425 of file SerializedFrame.h.

Constructor & Destructor Documentation

◆ SerializedFrame() [1/2]

agxData::SerializedFrame::SerializedFrame ( const agxData::Frame * frame )

◆ SerializedFrame() [2/2]

agxData::SerializedFrame::SerializedFrame ( SerializedFrame::Component * root )

◆ ~SerializedFrame()

virtual agxData::SerializedFrame::~SerializedFrame ( )

protectedvirtual

Member Function Documentation

◆ add() [1/4]

void agxData::SerializedFrame::add ( agx::UInt64 id )

◆ add() [2/4]

void agxData::SerializedFrame::add ( agxData::Array< agx::Index > & instances )

◆ add() [3/4]

void agxData::SerializedFrame::add ( agxData::Array< agxData::EntityPtr > & instances )

◆ add() [4/4]

void agxData::SerializedFrame::add ( agxData::EntityRange & instances )

◆ addChild()

void agxData::SerializedFrame::addChild ( Node * child )

◆ Buffer()

agxData::SerializedFrame::Buffer	(	const agx::Name &	name,
		agx::Index	id,
		BinaryData *	data,
		const Format *	format,
		size_t	numElements,
		size_t	byteOffset
	)

◆ capacity()

size_t agxData::SerializedFrame::capacity ( ) const

◆ Component()

agxData::SerializedFrame::Component	(	const agx::Name &	name,
		agx::Index	id = `agx::InvalidIndex`
	)

◆ createFrame()

static Frame * agxData::SerializedFrame::createFrame	(	const Component *	root,
		agx::UInt	index,
		agx::Real	timeStamp,
		agx::Real	timeStep
	)

static

◆ CustomBuffer()

agxData::SerializedFrame::CustomBuffer	(	const agx::Name &	name,
		agx::Index	id,
		const Format *	format,
		size_t	numElements
	)

◆ DataNode()

agxData::SerializedFrame::DataNode	(	const agx::Name &	name,
		agx::Index	id,
		BinaryData *	data,
		const Format *	format,
		size_t	numBytes,
		size_t	offset
	)

◆ EntityStorage() [1/2]

agxData::SerializedFrame::EntityStorage	(	const agx::Name &	name,
		agx::Index	id,
		EntityModel *	model,
		size_t	numElements,
		size_t	capacity
	)

◆ EntityStorage() [2/2]

agxData::SerializedFrame::EntityStorage ( const agxData::Frame::EntityStorage * storage )

◆ extractFrame() [1/3]

static Frame * agxData::SerializedFrame::extractFrame	(	agx::TiXmlElement *	eFrame,
		BinaryData *	dataSegment
	)

static

◆ extractFrame() [2/3]

static Frame * agxData::SerializedFrame::extractFrame	(	BinaryData *	headerSegment,
		BinaryData *	dataSegment
	)

static

◆ extractFrame() [3/3]

static Frame * agxData::SerializedFrame::extractFrame	(	BinaryData *	headerSegment,
		BinaryData *	dataSegment,
		ImportNameTable &	nameTable,
		bool	clearNameTableOnKeyFrame = `true`,
		FrameReader *	frameReader = `nullptr`
	)

static