spla::Descriptor Class Reference

Descriptor object used to parametrize execution of particular scheduled tasks. More...

#include <descriptor.hpp>

Inheritance diagram for spla::Descriptor:

Collaboration diagram for spla::Descriptor:

Public Types
enum class	TraversalMode { Push , Pull , PushPull }

Public Member Functions
	~Descriptor () override=default
void	set_traversal_mode (TraversalMode value)
void	set_front_factor (float value)
void	set_early_exit (bool value)
void	set_struct_only (bool value)
bool	get_push_only () const
bool	get_pull_only () const
bool	get_push_pull () const
float	get_front_factor () const
bool	get_early_exit () const
bool	get_struct_only () const
void	set_label (std::string label) override
const std::string &	get_label () const override
Public Member Functions inherited from spla::Object
	~Object () override=default
Public Member Functions inherited from spla::RefCnt
virtual	~RefCnt ()
bool	is_unique () const
std::int32_t	get_refs () const
std::int32_t	add_ref () const
std::int32_t	rel_ref () const

Static Public Member Functions
static ref_ptr< Descriptor >	make ()
	Makes new empty descriptor object. More...

Detailed Description

Descriptor object used to parametrize execution of particular scheduled tasks.

Member Enumeration Documentation

TraversalMode

enum spla::Descriptor::TraversalMode

strong

Enumerator
Push
Pull
PushPull

Constructor & Destructor Documentation

~Descriptor()

spla::Descriptor::~Descriptor ( )

overridedefault

Member Function Documentation

get_early_exit()

bool spla::Descriptor::get_early_exit ( ) const

inline

get_front_factor()

float spla::Descriptor::get_front_factor ( ) const

inline

get_label()

const std::string & spla::Descriptor::get_label ( ) const

overridevirtual

Implements spla::Object.

get_pull_only()

bool spla::Descriptor::get_pull_only ( ) const

inline

get_push_only()

bool spla::Descriptor::get_push_only ( ) const

inline

get_push_pull()

bool spla::Descriptor::get_push_pull ( ) const

inline

get_struct_only()

bool spla::Descriptor::get_struct_only ( ) const

inline

make()

ref_ptr< Descriptor > spla::Descriptor::make ( )

static

Makes new empty descriptor object.

Returns

New descriptor

set_early_exit()

void spla::Descriptor::set_early_exit ( bool  value )

inline

set_front_factor()

void spla::Descriptor::set_front_factor ( float  value )

inline

set_label()

void spla::Descriptor::set_label ( std::string  label )

overridevirtual

Implements spla::Object.

set_struct_only()

void spla::Descriptor::set_struct_only ( bool  value )

inline

set_traversal_mode()

void spla::Descriptor::set_traversal_mode ( TraversalMode  value )

inline

---

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

• include/spla/descriptor.hpp
• src/descriptor.cpp