BifrostGraph Executor common types and helpers. More...

Typedefs
using	BifrostGraph::Executor::StringArray = Amino::Array< Amino::String >
	Type alias to simplify usage of Amino::Array<Amino::String>. More...

Enumerations
enum class	BifrostGraph::Executor::MessageCategory : int { BifrostGraph::Executor::MessageCategory::kError , BifrostGraph::Executor::MessageCategory::kWarning , BifrostGraph::Executor::MessageCategory::kInfo }
	The category of a reported message. More...

enum class	BifrostGraph::Executor::MessageSource : int { BifrostGraph::Executor::MessageSource::kWorkspace , BifrostGraph::Executor::MessageSource::kLibrary , BifrostGraph::Executor::MessageSource::kGraphContainer , BifrostGraph::Executor::MessageSource::kJob , BifrostGraph::Executor::MessageSource::kTranslation }
	The source object of a reported message. More...

enum class	BifrostGraph::Executor::SetGraphMode : int { BifrostGraph::Executor::SetGraphMode::kDefault = 0 , BifrostGraph::Executor::SetGraphMode::kCopy = 1 }
	The mode controlling the behavior of GraphContainer::setGraph. More...

enum class	BifrostGraph::Executor::Uninitialized : int { BifrostGraph::Executor::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	BifrostGraph::Executor::PortClass : int { BifrostGraph::Executor::PortClass::eRegular , BifrostGraph::Executor::PortClass::eTerminal , BifrostGraph::Executor::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	BifrostGraph::Executor::PortDirection : int { BifrostGraph::Executor::PortDirection::kUndefined = 0 , BifrostGraph::Executor::PortDirection::kInput = 1 , BifrostGraph::Executor::PortDirection::kOutput = 2 }
	The direction of a port. More...

enum class	BifrostGraph::Executor::GraphCompilationMode : int { BifrostGraph::Executor::GraphCompilationMode::kInit , BifrostGraph::Executor::GraphCompilationMode::kUpdate }
	Modes for graph compilation. More...

enum class	BifrostGraph::Executor::GraphCompilationStatus : int { BifrostGraph::Executor::GraphCompilationStatus::kInvalid , BifrostGraph::Executor::GraphCompilationStatus::kFailure , BifrostGraph::Executor::GraphCompilationStatus::kSuccess , BifrostGraph::Executor::GraphCompilationStatus::kUnchanged }
	Status of graph compilation. More...

enum class	BifrostGraph::Executor::JobExecutionMode : int { BifrostGraph::Executor::JobExecutionMode::kDefault = 0 , BifrostGraph::Executor::JobExecutionMode::kResetStates = 1 }
	Modes for job execution. More...

enum class	BifrostGraph::Executor::JobExecutionStatus : int { BifrostGraph::Executor::JobExecutionStatus::kInvalid , BifrostGraph::Executor::JobExecutionStatus::kFailure , BifrostGraph::Executor::JobExecutionStatus::kSuccess }
	Status of job execution. More...

Functions
BifrostGraph::Executor::JobExecutionMode	operator\| (BifrostGraph::Executor::JobExecutionMode lhs, BifrostGraph::Executor::JobExecutionMode rhs)

BifrostGraph::Executor::JobExecutionMode &	operator\|= (BifrostGraph::Executor::JobExecutionMode &lhs, const BifrostGraph::Executor::JobExecutionMode rhs)

BifrostGraph::Executor::JobExecutionMode	operator& (BifrostGraph::Executor::JobExecutionMode lhs, BifrostGraph::Executor::JobExecutionMode rhs)

Detailed Description

BifrostGraph Executor common types and helpers.

Helpers for BifrostGraph::Executor::JobExecutionMode manipulation.

Typedef Documentation

◆ StringArray

using BifrostGraph::Executor::StringArray = typedef Amino::Array<Amino::String>

Type alias to simplify usage of Amino::Array<Amino::String>.

Definition at line 112 of file Types.h.

Enumeration Type Documentation

◆ GraphCompilationMode

enum class BifrostGraph::Executor::GraphCompilationMode : int

strong

Modes for graph compilation.

Enumerator
kInit	Compile the graph. This implies resetting the Amino runtime services instance and clearing any feedback port values.
kUpdate	Update the compiled graph. This implies that the Amino runtime services instance and any feedback port values should be kept.

Definition at line 82 of file Types.h.

◆ GraphCompilationStatus

enum class BifrostGraph::Executor::GraphCompilationStatus : int

strong

Status of graph compilation.

Enumerator
kInvalid	The GraphContainer is invalid.
kFailure	The graph compilation was unsuccessful: the graph contains errors.
kSuccess	The graph compilation was successful.
kUnchanged	The graph compilation was successful, and has no change compared to previous compilation.

Definition at line 90 of file Types.h.

◆ JobExecutionMode

enum class BifrostGraph::Executor::JobExecutionMode : int

strong

Modes for job execution.

Enumerator
kDefault	Execute the job normally.
kResetStates	Reset the job states (feedback ports) before execution.

Definition at line 99 of file Types.h.

◆ JobExecutionStatus

enum class BifrostGraph::Executor::JobExecutionStatus : int

strong

Status of job execution.

Enumerator
kInvalid	The Job is invalid.
kFailure	The job execution was completed with errors.
kSuccess	The job execution was completed successfully.

Definition at line 105 of file Types.h.

◆ MessageCategory

enum class BifrostGraph::Executor::MessageCategory : int

strong

The category of a reported message.

Enumerator
kError	The message refers to an error that prevents the regular execution of the current action.
kWarning	The message refers to a warning that doesn't prevent the execution of the current action.
kInfo	The message refers to user information.

Definition at line 33 of file Types.h.

◆ MessageSource

enum class BifrostGraph::Executor::MessageSource : int

strong

The source object of a reported message.

Enumerator
kWorkspace	The message is sent by the Workspace.
kLibrary	The message is sent by the Library.
kGraphContainer	The message is sent by a GraphContainer.
kJob	The message is sent by a Job.
kTranslation	The message is sent by a TypeTranslation.

Definition at line 42 of file Types.h.

◆ PortClass

enum class BifrostGraph::Executor::PortClass : int

strong

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.

Enumerator
eRegular	Regular input or output port. Known before graph compilation.
eTerminal	Terminal output port. Known after graph compilation.
eJobPort	Job input port. Known after graph compilation.

Definition at line 65 of file Types.h.

◆ PortDirection

enum class BifrostGraph::Executor::PortDirection : int

strong

The direction of a port.

Enumerator
kUndefined	The port is invalid and the I/O mode is undetermined.
kInput	The port is an input port.
kOutput	The port is an output port.

Definition at line 75 of file Types.h.

◆ SetGraphMode

enum class BifrostGraph::Executor::SetGraphMode : int

strong

The mode controlling the behavior of GraphContainer::setGraph.

Enumerator
kDefault	Set the designated graph as the new graph of this GraphContainer.
kCopy	Make a copy of the designated graph then set the copy as the new graph of this GraphContainer.

Definition at line 51 of file Types.h.

◆ Uninitialized

enum class BifrostGraph::Executor::Uninitialized : int

strong

Tag for explicitly specifying that a constructor should not initialize any data members, leaving the object in an invalid state.

Enumerator
kUninitialized	Uninitialized and in an invalid state.

Definition at line 59 of file Types.h.

Function Documentation

◆ operator&()

BifrostGraph::Executor::JobExecutionMode operator&	(	BifrostGraph::Executor::JobExecutionMode	lhs,
		BifrostGraph::Executor::JobExecutionMode	rhs
	)

inline

Definition at line 132 of file Types.h.

◆ operator|()

BifrostGraph::Executor::JobExecutionMode operator\|	(	BifrostGraph::Executor::JobExecutionMode	lhs,
		BifrostGraph::Executor::JobExecutionMode	rhs
	)

inline

Definition at line 122 of file Types.h.

◆ operator|=()

BifrostGraph::Executor::JobExecutionMode & operator\|=	(	BifrostGraph::Executor::JobExecutionMode &	lhs,
		const BifrostGraph::Executor::JobExecutionMode	rhs
	)

inline

Definition at line 127 of file Types.h.

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ StringArray

Enumeration Type Documentation

◆ GraphCompilationMode

◆ GraphCompilationStatus

◆ JobExecutionMode

◆ JobExecutionStatus

◆ MessageCategory

◆ MessageSource

◆ PortClass

◆ PortDirection

◆ SetGraphMode

◆ Uninitialized

Function Documentation

◆ operator&()

◆ operator|()

◆ operator|=()