Bifrost SDK
Bifrost SDK documentation
BifrostGraph::Executor Namespace Reference

Namespaces

namespace  Private
 
namespace  Utility
 

Classes

class  Callbacks
 BifrostGraph Executor Callbacks. More...
 
class  GraphContainer
 The GraphContainer class that loads a graph to be executed and manages the Jobs that execute this graph. More...
 
class  Job
 The Job class that executes a graph with inputs/outputs coming/going from/to host. More...
 
class  Library
 A Library of types and node definitions that can be used by Bifrost. More...
 
class  Owner
 The Owner<T> class template represents ownership of an object pointer. It indicates that the pointed object must either be transferred to another owner (like another Owner, or a std::unique_ptr) or deleted. Owner provides exception safety to classes and functions that handle objects with dynamic lifetime, by guaranteeing deletion of the pointed object on both normal exit or exit through exception. More...
 
class  TypeTranslation
 BifrostGraph Executor TypeTranslation. More...
 
class  Watchpoint
 BifrostGraph Executor Watchpoint. More...
 
class  WatchpointLayout
 A basic layout. More...
 
class  WatchpointLayoutArray
 Array layout. More...
 
class  WatchpointLayoutComposite
 A composite layout, that contains sub layouts. More...
 
class  WatchpointLayoutFactory
 Layout factory to build layouts for types and/or values. More...
 
class  WatchpointLayoutPath
 Path to an element in a layout. More...
 
class  WatchpointLayoutPtr
 A smart pointer on WatchpointLayout objects allowing them to be easily shared and managed. More...
 
class  Workspace
 The Workspace is the central element of the BifrostGraph Executor. More...
 

Typedefs

template<typename P >
using DeleterFunc = void(*)(P *p)
 The signature for the custom pointer deleter of a pointee p. This is the custom deleter type to use with the constructor Owner(P* p, DeleterFunc d). More...
 
using StringArray = Amino::Array< Amino::String >
 Type alias to simplify usage of Amino::Array<Amino::String>. More...
 

Enumerations

enum class  MessageCategory : int { MessageCategory::kError , MessageCategory::kWarning , MessageCategory::kInfo }
 The category of a reported message. More...
 
enum class  MessageSource : int {
  MessageSource::kWorkspace , MessageSource::kLibrary , MessageSource::kGraphContainer , MessageSource::kJob ,
  MessageSource::kTranslation
}
 The source object of a reported message. More...
 
enum class  SetGraphMode : int { SetGraphMode::kDefault = 0 , SetGraphMode::kCopy = 1 }
 The mode controlling the behavior of GraphContainer::setGraph. More...
 
enum class  Uninitialized : int { Uninitialized::kUninitialized }
 Tag for explicitly specifying that a constructor should not initialize any data members, leaving the object in an invalid state. More...
 
enum class  PortClass : int { PortClass::eRegular , PortClass::eTerminal , PortClass::eJobPort }
 The port class. This is to indicate if a port is a regular input or output port, a terminal output or a job port input. More...
 
enum class  PortDirection : int { PortDirection::kUndefined = 0 , PortDirection::kInput = 1 , PortDirection::kOutput = 2 }
 The direction of a port. More...
 
enum class  GraphCompilationMode : int { GraphCompilationMode::kInit , GraphCompilationMode::kUpdate }
 Modes for graph compilation. More...
 
enum class  GraphCompilationStatus : int { GraphCompilationStatus::kInvalid , GraphCompilationStatus::kFailure , GraphCompilationStatus::kSuccess , GraphCompilationStatus::kUnchanged }
 Status of graph compilation. More...
 
enum class  JobExecutionMode : int { JobExecutionMode::kDefault = 0 , JobExecutionMode::kResetStates = 1 }
 Modes for job execution. More...
 
enum class  JobExecutionStatus : int { JobExecutionStatus::kInvalid , JobExecutionStatus::kFailure , JobExecutionStatus::kSuccess }
 Status of job execution. More...
 

Functions

template<typename T , typename... Args>
Owner< T > makeOwner (Args &&... args)
 Create a new T object, constructed from the given arguments, and validate it with the expression T::isValid(). More...
 
template<typename T , typename... Args>
Owner< T > makeOwner (DeleterFunc< T > d, Args &&... args)
 Create a new T object, constructed from the given arguments, and validate it with the expression T::isValid(). More...