GraphRun Class

Declaration

class simaai::neat::graph::GraphRun { ... }

Included Headers

#include <GraphRun.h>

Friends Index

class	GraphSession

Public Constructors Index

	GraphRun ()=default
	GraphRun (const GraphRun &)=delete
	GraphRun (GraphRun &&) noexcept

Private Constructors Index

	GraphRun (std::shared_ptr< State > state)

Public Destructor Index

	~GraphRun ()

Public Operators Index

GraphRun &	operator= (const GraphRun &)=delete
GraphRun &	operator= (GraphRun &&) noexcept
	operator bool () const noexcept

Public Member Functions Index

bool	running () const
bool	push (NodeId node_id, const Sample &sample)
bool	push (NodeId node_id, PortId port, const Sample &sample)
std::optional< Sample >	pull (NodeId node_id, int timeout_ms=-1)
Input	input (NodeId node_id)
Input	input (NodeId node_id, PortId port)
Output	output (NodeId node_id)
GraphRunStats &	enable_stats ()
const GraphRunStats *	stats () const
PullSession	collect (const std::vector< Output > &outputs, GraphRunStats *stats=nullptr)
std::optional< Sample >	pull_any (const std::vector< Output > &outputs, int timeout_ms=-1, GraphRunStats *stats=nullptr, NodeId *out_node=nullptr)
bool	warmup (const std::vector< Output > &outputs, int warmup_count, int timeout_ms=-1)
void	pull_until (const std::vector< Output > &outputs, GraphRunStats &stats, const GraphRunPullOptions &opt, const std::function< void(const Sample &, NodeId)> &on_sample={})
StallGuard	stall_guard (const std::vector< Output > &outputs, int per_stream_target, int stall_ms, std::vector< std::string > stream_ids={})
void	emit_rate_summary (const GraphRunStats &stats) const
void	emit_rate_summary () const
void	emit_stream_summary (const GraphRunStats &stats) const
void	emit_stream_summary () const
void	emit_summary (const GraphRunStats &stats) const
void	emit_summary () const
std::string	describe () const
void	stop ()
std::string	last_error () const
void	last_error_or_throw () const

Private Member Attributes Index

std::shared_ptr< State >	state_

Definition at line 82 of file GraphRun.h.

Friends

GraphSession

friend class GraphSession

Definition at line 221 of file GraphRun.h.

221 friend class GraphSession;

Public Constructors

GraphRun()

simaai::neat::graph::GraphRun::GraphRun ()

default

Definition at line 171 of file GraphRun.h.

GraphRun()

simaai::neat::graph::GraphRun::GraphRun (const GraphRun &)

delete

Definition at line 172 of file GraphRun.h.

GraphRun()

simaai::neat::graph::GraphRun::GraphRun (GraphRun &&)

noexcept

Definition at line 175 of file GraphRun.h.

Private Constructors

GraphRun()

simaai::neat::graph::GraphRun::GraphRun (std::shared_ptr< State > state)

explicit

Definition at line 220 of file GraphRun.h.

Public Destructor

~GraphRun()

simaai::neat::graph::GraphRun::~GraphRun ()

Definition at line 177 of file GraphRun.h.

Public Operators

operator bool()

simaai::neat::graph::GraphRun::operator bool ()

explicit noexcept

Definition at line 179 of file GraphRun.h.

operator=()

GraphRun& simaai::neat::graph::GraphRun::operator= (const GraphRun &)

delete

Definition at line 173 of file GraphRun.h.

operator=()

GraphRun& simaai::neat::graph::GraphRun::operator= (GraphRun &&)

noexcept

Definition at line 176 of file GraphRun.h.

Public Member Functions

collect()

PullSession simaai::neat::graph::GraphRun::collect (const std::vector< Output > & outputs, GraphRunStats * stats=nullptr)

Definition at line 193 of file GraphRun.h.

describe()

std::string simaai::neat::graph::GraphRun::describe ()

Definition at line 210 of file GraphRun.h.

emit_rate_summary()

void simaai::neat::graph::GraphRun::emit_rate_summary (const GraphRunStats & stats)

Definition at line 203 of file GraphRun.h.

emit_rate_summary()

void simaai::neat::graph::GraphRun::emit_rate_summary ()

Definition at line 204 of file GraphRun.h.

emit_stream_summary()

void simaai::neat::graph::GraphRun::emit_stream_summary (const GraphRunStats & stats)

Definition at line 205 of file GraphRun.h.

emit_stream_summary()

void simaai::neat::graph::GraphRun::emit_stream_summary ()

Definition at line 206 of file GraphRun.h.

emit_summary()

void simaai::neat::graph::GraphRun::emit_summary (const GraphRunStats & stats)

Definition at line 207 of file GraphRun.h.

emit_summary()

void simaai::neat::graph::GraphRun::emit_summary ()

Definition at line 208 of file GraphRun.h.

enable_stats()

GraphRunStats& simaai::neat::graph::GraphRun::enable_stats ()

Definition at line 191 of file GraphRun.h.

input()

Input simaai::neat::graph::GraphRun::input (NodeId node_id)

Definition at line 187 of file GraphRun.h.

input()

Input simaai::neat::graph::GraphRun::input (NodeId node_id, PortId port)

Definition at line 188 of file GraphRun.h.

last_error()

std::string simaai::neat::graph::GraphRun::last_error ()

Definition at line 213 of file GraphRun.h.

last_error_or_throw()

void simaai::neat::graph::GraphRun::last_error_or_throw ()

Definition at line 214 of file GraphRun.h.

output()

Output simaai::neat::graph::GraphRun::output (NodeId node_id)

Definition at line 189 of file GraphRun.h.

pull()

std::optional<Sample> simaai::neat::graph::GraphRun::pull (NodeId node_id, int timeout_ms=-1)

Definition at line 185 of file GraphRun.h.

pull_any()

std::optional<Sample> simaai::neat::graph::GraphRun::pull_any (const std::vector< Output > & outputs, int timeout_ms=-1, GraphRunStats * stats=nullptr, NodeId * out_node=nullptr)

Definition at line 195 of file GraphRun.h.

pull_until()

void simaai::neat::graph::GraphRun::pull_until (const std::vector< Output > & outputs, GraphRunStats & stats, const GraphRunPullOptions & opt, const std::function< void(const Sample &, NodeId)> & on_sample={})

Definition at line 198 of file GraphRun.h.

push()

bool simaai::neat::graph::GraphRun::push (NodeId node_id, const Sample & sample)

Definition at line 182 of file GraphRun.h.

push()

bool simaai::neat::graph::GraphRun::push (NodeId node_id, PortId port, const Sample & sample)

Definition at line 183 of file GraphRun.h.

running()

bool simaai::neat::graph::GraphRun::running ()

Definition at line 180 of file GraphRun.h.

stall_guard()

StallGuard simaai::neat::graph::GraphRun::stall_guard (const std::vector< Output > & outputs, int per_stream_target, int stall_ms, std::vector< std::string > stream_ids={})

Definition at line 201 of file GraphRun.h.

stats()

const GraphRunStats* simaai::neat::graph::GraphRun::stats ()

Definition at line 192 of file GraphRun.h.

stop()

void simaai::neat::graph::GraphRun::stop ()

Definition at line 212 of file GraphRun.h.

warmup()

bool simaai::neat::graph::GraphRun::warmup (const std::vector< Output > & outputs, int warmup_count, int timeout_ms=-1)

Definition at line 197 of file GraphRun.h.

Private Member Attributes

state_

std::shared_ptr<State> simaai::neat::graph::GraphRun::state_

Definition at line 218 of file GraphRun.h.

217 struct State;

---

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

• GraphRun.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.1.