OpenVDB  8.1.1
Public Types | Public Member Functions | Friends | List of all members
PointExecutable Class Reference

Object that encapsulates compiled AX code which can be executed on a collection of VDB Point Data grids. Executables are created by the compiler and hold the final immutable JIT compiled function and context. More...

#include <PointExecutable.h>

Public Types

using Ptr = std::shared_ptr< PointExecutable >
 

Public Member Functions

 ~PointExecutable ()
 
 PointExecutable (const PointExecutable &other)
 Copy constructor. Shares the LLVM constructs but deep copies the settings. Multiple copies of an executor can be used at the same time safely. More...
 
void execute (points::PointDataGrid &grid) const
 Run this point executable binary on a target PointDataGrid. More...
 
void setGroupExecution (const std::string &name)
 Set a specific point group to execute over. The default is none, which corresponds to all points. Note that this can also be compiled into the AX function using the ingroup("mygroup") method. More...
 
const std::string & getGroupExecution () const
 
void setCreateMissing (const bool flag)
 Set the behaviour when missing point attributes are accessed. Default behaviour is true, which creates them with default initial values. If false, a missing attribute runtime error will be thrown on missing accesses. More...
 
bool getCreateMissing () const
 
void setGrainSize (const size_t grain)
 Set the threading grain size. Default is 1. A value of 0 has the effect of disabling multi-threading. More...
 
size_t getGrainSize () const
 

Friends

class Compiler
 
class ::TestPointExecutable
 

Detailed Description

Object that encapsulates compiled AX code which can be executed on a collection of VDB Point Data grids. Executables are created by the compiler and hold the final immutable JIT compiled function and context.

The PointExecutable is returned from the ax::Compiler when compiling AX code for point execution. The class represents a typical AX executable object; immutable except for execution settings and implements 'execute' functions which can be called multiple times for arbitrary sets of inputs. The intended usage of these executables is to configure their runtime arguments and then call PointExecutable::execute with your VDBs. For example:

PointExecutable::Ptr exe = compiler.compile<PointExecutable>("@a += 1");
exe->setCreateMissing(false); // fail on missing attributes
exe->setGroupExecution("group1"); // only process points in group1
exe->execute(vdbs); // run on a set of vdb point data grids
exe->execute(points); // run on a single point data grid

The setCreateMissing is initialised with specific configurable settings:

Member Typedef Documentation

using Ptr = std::shared_ptr<PointExecutable>

Constructor & Destructor Documentation

PointExecutable ( const PointExecutable other)

Copy constructor. Shares the LLVM constructs but deep copies the settings. Multiple copies of an executor can be used at the same time safely.

Member Function Documentation

void execute ( points::PointDataGrid grid) const

Run this point executable binary on a target PointDataGrid.

This method reads from the stored settings on the executable to determine certain behaviour and runs the JIT compiled function across every valid point. Point attributes may be created, deleted collapsed or expanded, and points themselves may be added, deleted or moved.

This method is thread safe; it can be run concurrently from the same PointExecutable instance on different inputs.

Parameters
gridThe PointDataGrid to process
bool getCreateMissing ( ) const
Returns
Whether this executable will generate new point attributes.
size_t getGrainSize ( ) const
Returns
The current grain size
const std::string& getGroupExecution ( ) const
Returns
The points group to be processed. Default is empty, which is all points.
void setCreateMissing ( const bool  flag)

Set the behaviour when missing point attributes are accessed. Default behaviour is true, which creates them with default initial values. If false, a missing attribute runtime error will be thrown on missing accesses.

Parameters
flagEnables or disables the creation of missing attributes
void setGrainSize ( const size_t  grain)

Set the threading grain size. Default is 1. A value of 0 has the effect of disabling multi-threading.

Parameters
grainThe grain size
void setGroupExecution ( const std::string &  name)

Set a specific point group to execute over. The default is none, which corresponds to all points. Note that this can also be compiled into the AX function using the ingroup("mygroup") method.

Warning
If the group does not exist during execute, a runtime error will be thrown.
Parameters
nameThe name of the group to execute over

Friends And Related Function Documentation

friend class ::TestPointExecutable
friend
friend class Compiler
friend

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