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

#include <APEX_Types.h>

+ Inheritance diagram for apex::APEX_VoidTypeDefinition:

Public Member Functions

 APEX_VoidTypeDefinition ()
 
 ~APEX_VoidTypeDefinition () override
 
size_t sizeT () const override
 Return the size of a single instance of the type, or 0 if the type is not well-defined (i.e. a void). More...
 
const UT_StringRefrepr () const override
 Return a human-readable string representing the type. More...
 
voidallocate (exint size) const override
 
void clear (void *mem) const override
 Reset the instance of this type (member of buffer created in allocate) to a default value if possible. More...
 
exint append (void *mem) const override
 
void deallocate (void *mem) const override
 Free a resizable array created by allocate. More...
 
voidgetPtrAtIndex (void *mem, exint index) const override
 Get a pointer to the {index}-th value in the resizable array created by allocate stored at mem. More...
 
void setData (void *mem, const void *val) const override
 Copy the value at val to mem. More...
 
bool compile (APEX_Buffer *buffer, APEX_Graph *graph, APEX_PortID port) const override
 
const APEX_TypeDefinitionBasesubTypeDef () const override
 If this is a compound type (such as variadics), return the type definition for the contained type. More...
 
std::type_index typeIndex () const override
 Return the RTTI information for the contained type. More...
 
bool isCopyable () const override
 Return whether the type is copy-assignable (i.e. can setData function). More...
 
- Public Member Functions inherited from apex::APEX_TypeDefinitionBase
virtual ~APEX_TypeDefinitionBase ()
 
virtual bool isArray () const
 Return whether the type is an array. More...
 
virtual bool isVariadic () const
 Return whether the type is a variadic arg. More...
 
virtual bool isHandle () const
 Return whether the type is a handle to some shared data (i.e. geometry) More...
 

Detailed Description

Definition at line 246 of file APEX_Types.h.

Constructor & Destructor Documentation

apex::APEX_VoidTypeDefinition::APEX_VoidTypeDefinition ( )
inline

Definition at line 249 of file APEX_Types.h.

apex::APEX_VoidTypeDefinition::~APEX_VoidTypeDefinition ( )
inlineoverride

Definition at line 261 of file APEX_Types.h.

Member Function Documentation

void* apex::APEX_VoidTypeDefinition::allocate ( exint  size) const
inlineoverridevirtual

Allocate a resizable array of the type. The current implementation uses a UT_Array behind-the-scenes, however the implementation is type-erased to allow flexibility.

Implements apex::APEX_TypeDefinitionBase.

Definition at line 265 of file APEX_Types.h.

exint apex::APEX_VoidTypeDefinition::append ( void mem) const
inlineoverridevirtual

Append a default-constructed instance to the array previously allocated by allocate. If no allocation could be performed, return -1.

Implements apex::APEX_TypeDefinitionBase.

Definition at line 267 of file APEX_Types.h.

void apex::APEX_VoidTypeDefinition::clear ( void mem) const
inlineoverridevirtual

Reset the instance of this type (member of buffer created in allocate) to a default value if possible.

Implements apex::APEX_TypeDefinitionBase.

Definition at line 266 of file APEX_Types.h.

bool apex::APEX_VoidTypeDefinition::compile ( APEX_Buffer buffer,
APEX_Graph *  graph,
APEX_PortID  port 
) const
inlineoverridevirtual

Implements apex::APEX_TypeDefinitionBase.

Definition at line 271 of file APEX_Types.h.

void apex::APEX_VoidTypeDefinition::deallocate ( void mem) const
inlineoverridevirtual

Free a resizable array created by allocate.

Implements apex::APEX_TypeDefinitionBase.

Definition at line 268 of file APEX_Types.h.

void* apex::APEX_VoidTypeDefinition::getPtrAtIndex ( void mem,
exint  index 
) const
inlineoverridevirtual

Get a pointer to the {index}-th value in the resizable array created by allocate stored at mem.

Implements apex::APEX_TypeDefinitionBase.

Definition at line 269 of file APEX_Types.h.

bool apex::APEX_VoidTypeDefinition::isCopyable ( ) const
inlineoverridevirtual

Return whether the type is copy-assignable (i.e. can setData function).

Implements apex::APEX_TypeDefinitionBase.

Definition at line 274 of file APEX_Types.h.

const UT_StringRef& apex::APEX_VoidTypeDefinition::repr ( ) const
inlineoverridevirtual

Return a human-readable string representing the type.

Implements apex::APEX_TypeDefinitionBase.

Definition at line 264 of file APEX_Types.h.

void apex::APEX_VoidTypeDefinition::setData ( void mem,
const void val 
) const
inlineoverridevirtual

Copy the value at val to mem.

Implements apex::APEX_TypeDefinitionBase.

Definition at line 270 of file APEX_Types.h.

size_t apex::APEX_VoidTypeDefinition::sizeT ( ) const
inlineoverridevirtual

Return the size of a single instance of the type, or 0 if the type is not well-defined (i.e. a void).

Implements apex::APEX_TypeDefinitionBase.

Definition at line 263 of file APEX_Types.h.

const APEX_TypeDefinitionBase* apex::APEX_VoidTypeDefinition::subTypeDef ( ) const
inlineoverridevirtual

If this is a compound type (such as variadics), return the type definition for the contained type.

Implements apex::APEX_TypeDefinitionBase.

Definition at line 272 of file APEX_Types.h.

std::type_index apex::APEX_VoidTypeDefinition::typeIndex ( ) const
inlineoverridevirtual

Return the RTTI information for the contained type.

Implements apex::APEX_TypeDefinitionBase.

Definition at line 273 of file APEX_Types.h.


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