catapult::sync::TasksConfiguration Struct Reference

Tasks configuration settings. More...

Classes
struct	TaskConfiguration
	Task configuration that is a union of all supported task configurations. More...

Public Types
enum	TaskType { TaskType::Uniform, TaskType::Decelerating }
	Supported task types. More...

Static Public Member Functions
static TasksConfiguration	Uninitialized ()
	Creates an uninitialized tasks configuration. More...
static TasksConfiguration	LoadFromBag (const utils::ConfigurationBag &bag)
	Loads a tasks configuration from bag. More...
static TasksConfiguration	LoadFromPath (const boost::filesystem::path &resourcesPath)
	Loads a tasks configuration from resourcesPath. More...

Public Attributes
std::unordered_map< std::string, TaskConfiguration >	Tasks
	A map of task names to task configurations. More...

Private Member Functions
	TasksConfiguration ()=default

Detailed Description

Tasks configuration settings.

Member Enumeration Documentation

TaskType

enum catapult::sync::TasksConfiguration::TaskType

strong

Supported task types.

Enumerator
Uniform	A task that is scheduled with constant intervals.
Decelerating	A task that is scheduled with increasing intervals.

Constructor & Destructor Documentation

TasksConfiguration()

catapult::sync::TasksConfiguration::TasksConfiguration ( )

privatedefault

Here is the caller graph for this function:

Member Function Documentation

LoadFromBag()

TasksConfiguration catapult::sync::TasksConfiguration::LoadFromBag ( const utils::ConfigurationBag &  bag )

static

Loads a tasks configuration from bag.

Here is the call graph for this function:

LoadFromPath()

TasksConfiguration catapult::sync::TasksConfiguration::LoadFromPath ( const boost::filesystem::path &  resourcesPath )

static

Loads a tasks configuration from resourcesPath.

Uninitialized()

TasksConfiguration catapult::sync::TasksConfiguration::Uninitialized ( )

static

Creates an uninitialized tasks configuration.

Here is the call graph for this function:

Member Data Documentation

Tasks

std::unordered_map<std::string, TaskConfiguration> catapult::sync::TasksConfiguration::Tasks

A map of task names to task configurations.

---

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

• TasksConfiguration.h
• TasksConfiguration.cpp