Bifrost SDK
Bifrost SDK documentation
Types.h
Go to the documentation of this file.
1//-
2// ================================================================================================
3// Copyright 2024 Autodesk, Inc. All rights reserved.
4//
5// Use of this software is subject to the terms of the Autodesk license agreement provided
6// at the time of installation or download, or which otherwise accompanies this software in
7// either electronic or hard copy form.
8// ================================================================================================
9//+
10
15
16#ifndef BIFROSTGRAPH_EXECUTOR_TYPES_H
17#define BIFROSTGRAPH_EXECUTOR_TYPES_H
18
19#include <BifrostGraph/Executor/internal/ExecutorExport.h>
20
21#include <Amino/Core/Array.h>
22#include <Amino/Core/String.h>
23
24namespace BifrostGraph {
25namespace Executor {
26
31
33enum class MessageCategory : int {
34 kError,
36 kWarning,
38 kInfo
39};
40
42enum class MessageSource : int {
44 kLibrary,
46 kJob,
48};
49
51enum class SetGraphMode : int {
52 kDefault = 0,
53 kCopy = 1
55};
56
59enum class Uninitialized : int {
61};
62
65enum class PortClass : int {
66 eRegular,
68
69 eTerminal,
70
72};
73
75enum class PortDirection : int {
76 kUndefined = 0,
77 kInput = 1,
78 kOutput = 2
79};
80
82enum class GraphCompilationMode : int {
83 kInit,
85 kUpdate
87};
88
90enum class GraphCompilationStatus : int {
91 kInvalid,
92 kFailure,
93 kSuccess,
96};
97
99enum class JobExecutionMode : int {
100 kDefault = 0,
101 kResetStates = 1
102};
103
105enum class JobExecutionStatus : int {
106 kInvalid,
107 kFailure,
108 kSuccess
109};
110
113
115
116} // namespace Executor
117} // namespace BifrostGraph
118
124 return static_cast<BifrostGraph::Executor::JobExecutionMode>(static_cast<int>(lhs) |
125 static_cast<int>(rhs));
126}
130 return lhs = lhs | rhs;
131}
134 return static_cast<BifrostGraph::Executor::JobExecutionMode>(static_cast<int>(lhs) &
135 static_cast<int>(rhs));
136}
138
139#endif // BIFROST_GRAPH_EXECUTOR_TYPES_H
A resizable container of contiguous elements.
String class.
PortClass
The port class. This is to indicate if a port is a regular input or output port, a terminal output or...
Definition: Types.h:65
PortDirection
The direction of a port.
Definition: Types.h:75
MessageSource
The source object of a reported message.
Definition: Types.h:42
GraphCompilationMode
Modes for graph compilation.
Definition: Types.h:82
JobExecutionMode
Modes for job execution.
Definition: Types.h:99
BifrostGraph::Executor::JobExecutionMode operator|(BifrostGraph::Executor::JobExecutionMode lhs, BifrostGraph::Executor::JobExecutionMode rhs)
Definition: Types.h:122
Uninitialized
Tag for explicitly specifying that a constructor should not initialize any data members,...
Definition: Types.h:59
JobExecutionStatus
Status of job execution.
Definition: Types.h:105
SetGraphMode
The mode controlling the behavior of GraphContainer::setGraph.
Definition: Types.h:51
BifrostGraph::Executor::JobExecutionMode & operator|=(BifrostGraph::Executor::JobExecutionMode &lhs, const BifrostGraph::Executor::JobExecutionMode rhs)
Definition: Types.h:127
MessageCategory
The category of a reported message.
Definition: Types.h:33
BifrostGraph::Executor::JobExecutionMode operator&(BifrostGraph::Executor::JobExecutionMode lhs, BifrostGraph::Executor::JobExecutionMode rhs)
Definition: Types.h:132
GraphCompilationStatus
Status of graph compilation.
Definition: Types.h:90
@ eJobPort
Job input port. Known after graph compilation.
@ eTerminal
Terminal output port. Known after graph compilation.
@ 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.
@ kTranslation
The message is sent by a TypeTranslation.
@ kLibrary
The message is sent by the Library.
@ kGraphContainer
The message is sent by a GraphContainer.
@ kWorkspace
The message is sent by the Workspace.
@ kJob
The message is sent by a Job.
@ kResetStates
Reset the job states (feedback ports) before execution.
@ kUninitialized
Uninitialized and in an invalid state.
@ kDefault
Set the designated graph as the new graph of this GraphContainer.
@ kFailure
The graph compilation was unsuccessful: the graph contains errors.
@ kSuccess
The graph compilation was successful.
@ kInvalid
The GraphContainer is invalid.
Define a Amino array of elements of type T.
Definition: Array.h:105