HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
apex::APEX_Buffer Class Reference

Holds all of the memory for execution state of a compiled APEX graph. More...

#include <APEX_Buffer.h>

+ Inheritance diagram for apex::APEX_Buffer:

Public Member Functions

 APEX_Buffer ()
 
void clear ()
 
APEX_TypedBufferfindTypedBuffer (const APEX_TypeDefinitionBase *type_defn)
 Get the type-specific storage for a given type, or nullptr if not found. More...
 
APEX_TypedBuffergetTypedBuffer (exint index)
 
exint typeIndex (const APEX_TypeDefinitionBase *type_defn)
 Get the index at which a given type is stored in this buffer, or -1 if not present. More...
 
exint allocate (const APEX_TypeDefinitionBase *type_defn, exint size)
 
APEX_Argument append (const APEX_TypeDefinitionBase *type_defn)
 Extend the type-specific storage buffer of the given type by one element and return an ApexArgument tracking it. More...
 
void set (APEX_Argument &arg, void *value)
 Set the value of the given argument in this buffer to the value. The type of the argument must support copying. More...
 
void lock ()
 Prevent further modifications to the layout of this buffer. More...
 

Static Public Member Functions

static APEX_DataID nextDataId ()
 Get a new unique data ID. More...
 

Detailed Description

Holds all of the memory for execution state of a compiled APEX graph.

Definition at line 96 of file APEX_Buffer.h.

Constructor & Destructor Documentation

apex::APEX_Buffer::APEX_Buffer ( )
inline

Definition at line 99 of file APEX_Buffer.h.

Member Function Documentation

exint apex::APEX_Buffer::allocate ( const APEX_TypeDefinitionBase type_defn,
exint  size 
)
inline

Allocate a type-specific storage buffer of the given type of the given size. Returns the index of the new storage.

Definition at line 148 of file APEX_Buffer.h.

APEX_Argument apex::APEX_Buffer::append ( const APEX_TypeDefinitionBase type_defn)

Extend the type-specific storage buffer of the given type by one element and return an ApexArgument tracking it.

void apex::APEX_Buffer::clear ( )
inline

Definition at line 105 of file APEX_Buffer.h.

APEX_TypedBuffer* apex::APEX_Buffer::findTypedBuffer ( const APEX_TypeDefinitionBase type_defn)
inline

Get the type-specific storage for a given type, or nullptr if not found.

Definition at line 112 of file APEX_Buffer.h.

APEX_TypedBuffer* apex::APEX_Buffer::getTypedBuffer ( exint  index)
inline

Definition at line 122 of file APEX_Buffer.h.

void apex::APEX_Buffer::lock ( )
inline

Prevent further modifications to the layout of this buffer.

Definition at line 167 of file APEX_Buffer.h.

static APEX_DataID apex::APEX_Buffer::nextDataId ( )
static

Get a new unique data ID.

void apex::APEX_Buffer::set ( APEX_Argument arg,
void value 
)

Set the value of the given argument in this buffer to the value. The type of the argument must support copying.

exint apex::APEX_Buffer::typeIndex ( const APEX_TypeDefinitionBase type_defn)
inline

Get the index at which a given type is stored in this buffer, or -1 if not present.

Definition at line 130 of file APEX_Buffer.h.


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