12#ifndef OPENVDB_AX_COMPILER_VOLUME_EXECUTABLE_HAS_BEEN_INCLUDED
13#define OPENVDB_AX_COMPILER_VOLUME_EXECUTABLE_HAS_BEEN_INCLUDED
19#include <openvdb/version.h>
22#include <unordered_map>
24class TestVolumeExecutable;
82 using Ptr = std::shared_ptr<VolumeExecutable>;
274 static CLI create(
size_t argc,
const char* argv[],
bool* used=
nullptr);
275 static void usage(std::ostream& os,
const bool verbose);
279 std::unique_ptr<Settings<true>> mSettings;
292 Index getTreeExecutionLevel() const;
296 friend class ::TestVolumeExecutable;
313 const
std::shared_ptr<const
llvm::ExecutionEngine>& engine,
316 const
std::unordered_map<
std::
string, uint64_t>& functions,
317 const ast::Tree& tree);
322 const
std::shared_ptr<const
llvm::LLVMContext> mContext;
323 const
std::shared_ptr<const
llvm::ExecutionEngine> mExecutionEngine;
326 const
std::unordered_map<
std::
string, uint64_t> mFunctionAddresses;
The Attribute Bindings class is used by the compiled Executables to handle the mapping of AX Attribut...
These classes contain lists of expected attributes and volumes which are populated by compiler during...
Access to the CustomData class which can provide custom user user data to the OpenVDB AX Compiler.
Abstract base class for typed grids.
Definition: Grid.h:78
This class wraps an interface for a map of attribute bindings. These map attributes in AX code to con...
Definition: AttributeBindings.h:37
This class stores a list of access names, types and their dependency connections.
Definition: AttributeRegistry.h:39
The compiler class. This holds an llvm context and set of compiler options, and constructs executable...
Definition: Compiler.h:50
The custom data class is a simple container for named openvdb metadata. Its primary use case is passi...
Definition: CustomData.h:34
Object that encapsulates compiled AX code which can be executed on a collection of VDB volume grids....
Definition: VolumeExecutable.h:80
void setActiveTileStreamingGrainSize(const size_t g2)
Set the threading grain sizes used when iterating over nodes in a VDB.
void setCreateMissing(const bool flag)
Set the behaviour when missing grids are accessed. Default behaviour is true, which creates them with...
const AttributeBindings & getAttributeBindings() const
void execute(openvdb::GridBase &grids) const
Run this volume executable binary on target volumes.
void getTreeExecutionLevel(Index &min, Index &max) const
Get the tree execution levels.
Streaming getActiveTileStreaming() const
IterType getValueIterator() const
std::shared_ptr< VolumeExecutable > Ptr
Definition: VolumeExecutable.h:82
void setValueIterator(const IterType &iter)
Set the value iterator type to use with this executable. Options are ON, OFF, ALL....
void setActiveTileStreaming(const Streaming &s)
Controls the behaviour of expansion of active tiles.
void setGrainSize(const size_t g1)
Set the threading grain sizes used when iterating over nodes in a VDB.
Streaming getActiveTileStreaming(const std::string &name, const ast::tokens::CoreType &type) const
size_t getGrainSize() const
void setTreeExecutionLevel(const Index min, const Index max)
Set the execution level for this executable. This controls what nodes are processed when execute is c...
void setSettingsFromCLI(const CLI &cli)
Intialize the Settings of this executables from the CLI object.
Streaming
The streaming type of active tiles during execution.
Definition: VolumeExecutable.h:197
bool getCreateMissing() const
void setTreeExecutionLevel(const Index level)
IterType
Definition: VolumeExecutable.h:210
void execute(openvdb::GridPtrVec &grids) const
Run this volume executable binary on target volumes.
void setAttributeBindings(const AttributeBindings &bindings)
Set attribute bindings.
size_t getActiveTileStreamingGrainSize() const
VolumeExecutable(const VolumeExecutable &other)
Copy constructor. Shares the LLVM constructs but deep copies the settings. Multiple copies of an exec...
Definition: Compiler.h:31
CoreType
Definition: Tokens.h:32
std::vector< GridBase::Ptr > GridPtrVec
Definition: Grid.h:508
Index32 Index
Definition: Types.h:54
Definition: Exceptions.h:13
Command Line Interface handling for the VolumeExecutable.
Definition: VolumeExecutable.h:270
static void usage(std::ostream &os, const bool verbose)
static CLI create(size_t argc, const char *argv[], bool *used=nullptr)
Definition: VolumeExecutable.h:263
#define OPENVDB_VERSION_NAME
The version namespace name for this library version.
Definition: version.h.in:121
#define OPENVDB_USE_VERSION_NAMESPACE
Definition: version.h.in:212