#include <FramePacket.h>

Inheritance diagram for agxNet::FramePacket:

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

agx::UInt32	getBinarySegmentOffset () const

agx::UInt32	getBinarySegmentSize () const

const agxJson::Value &	getHeader () const

const agx::String &	getHeaderString () const

agx::UInt32	getPostHeaderPaddingSize () const

const StructuredMessage::PreHeader &	getPreHeader () const

const agx::String &	getUri () const

Public Member Functions inherited from agxData::SerializedFrame
	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 agxData::Frame *	parseFrame (agx::UInt8 *data, size_t size)

static agxData::Frame *	parseFrame (const agxJson::Value &eFrame, agxData::BinaryData *binaryData)

Static Public Member Functions inherited from agxData::SerializedFrame
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)

Protected Member Functions
virtual	~FramePacket ()

Protected Member Functions inherited from agxData::SerializedFrame
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
Public Types inherited from agxData::SerializedFrame
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

Static Public Attributes inherited from agxData::SerializedFrame
static const agx::UInt64	DATA_SEGMENT_ALIGNMENT = 32

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 127 of file FramePacket.h.

Constructor & Destructor Documentation

◆ FramePacket()

agxNet::FramePacket::FramePacket ( const agxData::Frame * frame )

◆ ~FramePacket()

virtual agxNet::FramePacket::~FramePacket ( )

inlineprotectedvirtual

Definition at line 153 of file FramePacket.h.

Member Function Documentation

◆ getBinarySegmentOffset()

agx::UInt32 agxNet::FramePacket::getBinarySegmentOffset ( ) const

Returns: The offset to the binary segment

Definition at line 196 of file FramePacket.h.

◆ getBinarySegmentSize()

agx::UInt32 agxNet::FramePacket::getBinarySegmentSize ( ) const

Returns: The total size in bytes of the binary segment, including buffer padding but not post-header padding.

Definition at line 197 of file FramePacket.h.

◆ getHeader()

const agxJson::Value & agxNet::FramePacket::getHeader ( ) const

Definition at line 200 of file FramePacket.h.

◆ getHeaderString()

const agx::String & agxNet::FramePacket::getHeaderString ( ) const

Definition at line 201 of file FramePacket.h.

◆ getPostHeaderPaddingSize()

agx::UInt32 agxNet::FramePacket::getPostHeaderPaddingSize ( ) const

Returns: The size in bytes of the padding between the header and the buffer segment.

Definition at line 202 of file FramePacket.h.

◆ getPreHeader()

const StructuredMessage::PreHeader & agxNet::FramePacket::getPreHeader ( ) const

Returns: The preheader

Definition at line 195 of file FramePacket.h.

◆ getUri()

const agx::String & agxNet::FramePacket::getUri ( ) const

Definition at line 199 of file FramePacket.h.

◆ parseFrame() [1/2]

static agxData::Frame * agxNet::FramePacket::parseFrame	(	agx::UInt8 *	data,
		size_t	size
	)

static

◆ parseFrame() [2/2]

static agxData::Frame * agxNet::FramePacket::parseFrame	(	const agxJson::Value &	eFrame,
		agxData::BinaryData *	binaryData
	)