steam::control Namespace Reference

Description

Steam-Layer dispatcher, controller and administrative facilities.

Namespaces
namespace	anonymous_namespace{command-setup.cpp}
namespace	anonymous_namespace{command.cpp}
namespace	anonymous_namespace{handling-patterns.hpp}
namespace	anonymous_namespace{looper.hpp}
namespace	anonymous_namespace{session-command-service.cpp}
namespace	bind_arg
namespace	com
namespace	impl
namespace	stage
namespace	test

Typedefs
using	CmdFunctor = FunErasure< StoreFunction >
	A neutral container internally holding the functor used to implement the Command.
using	PClo = std::shared_ptr< CmdClosure >
using	DefinitionClosure = std::function< void(CommandDef &)>
using	FuncPtr = void *

Classes
class	AcceptAnyBinding
	Helper Template for control::Command, mix-in complete set of bind(...) functions. More...
class	AcceptArgumentBinding
	Helper Template for Steam-Layer control::Command : mix in a bind(...) function. More...
class	AcceptArgumentBindingRet
	Variation of AcceptArgumentBinding, allowing to control the return type of the generated bind(...) functions independently from SIG. More...
class	AcceptArgumentTuple
	Helper Template for building a Functor or function-like class: Mix in a function call operator, which mimics the specified signature SIG . More...
struct	Arguments
class	CmdClosure
	Interface. More...
class	Command
	Handle object representing a single Command instance to be used by client code. More...
class	CommandDef
	Helper class used solely for defining a Command-Object. More...
class	CommandDispatch
	Interface of a service to perform Commands on the session. More...
class	CommandImpl
	Steam-Layer Command implementation. More...
class	CommandImplCloneBuilder
	Visitor to support creating a CommandImpl clone. More...
class	CommandInstanceManager
	Maintain a current command instance for parametrisation. More...
class	CommandQueue
	Implementation of the Session's command queue. More...
class	CommandRegistry
	Registry managing command implementation objects (Singleton). More...
class	CommandSetup
	Marker and Helper for writing Steam-Layer Command definitions. More...
class	CommandSignature
	Metaprogramming helper for building Command function signatures. More...
class	DispatcherLoop
	PImpl within SteamDispatcher to implement the Session Loop Thread. More...
class	ExecResult
	Result (Status) of command execution. More...
class	HandlingPattern
	Interface: Operation Skeleton how to invoke or undo a command. More...
class	Looper
	Encapsulated control logic for the session thread loop. More...
class	MediaImplLib
class	MementoTie
	Binding together state capturing and execution of the undo operation. More...
class	Mutation
	Unspecific command functor for implementing Steam-Layer Command. More...
class	OpClosure
	closure to deal with the actual command operation. More...
struct	order_by_impl
	Helper for building a std::map with Command* as keys. More...
class	ParamAccessor
	Helper for accessing an individual function parameter. More...
class	ParamAccessor< Nil, TUP, TUP, n >
	< used for recursion end of implementation functions More...
class	PathManager
	While building a render engine, this Strategy class decides on the actual render strategy in accordance to the current controller settings (system state) More...
class	SessionCommand
	Global access point to invoke commands and cause edit operations within the Session. More...
class	SessionCommandService
	Actual implementation of the SessionCommand service within the Lumiera Session subsystem. More...
class	SimpleClosure
	Dummy / proof-of-concept implementation of CmdClosure. More...
class	SteamDispatcher
	Guard to manage processing commands to operate on the session. More...
class	StorageHolder
	This is "the" top level CmdClosure implementation. More...
class	STypeManager
struct	TypedArguments
class	UndoMutation
	Specialised version of the command Mutation functor, used to implement the UNDO functionality. More...
class	UndoSignature
	Type analysis helper template. More...

Functions
com::RuntimeCheckedCommandInvoker	invoke (Symbol cmdID)
com::RuntimeCheckedCommandInvoker	invoke (CStr cmdID)
bool	operator== (Command const &c1, Command const &c2)
bool	operator!= (Command const &c1, Command const &c2)
bool	operator< (Command const &c1, Command const &c2)
	allow for sets and associative containers
CStr	ON_STREAMTYPES_RESET ("ON_STREAMTYPES_RESET")

Variables
CStr	ON_STREAMTYPES_RESET
	triggered to load the generic pristine default

Typedef Documentation

CmdFunctor

using CmdFunctor = FunErasure<StoreFunction>

A neutral container internally holding the functor used to implement the Command.

Definition at line 84 of file command-closure.hpp.

PClo

using PClo = std::shared_ptr<CmdClosure>

Definition at line 109 of file command-closure.hpp.

DefinitionClosure

using DefinitionClosure = std::function<void(CommandDef&)>

Definition at line 65 of file command-setup.hpp.

FuncPtr

using FuncPtr = void*

Definition at line 93 of file command.hpp.

---

Class Documentation

steam::control::PathManager

class steam::control::PathManager

Collaboration diagram for PathManager:

Function Documentation

invoke() [1/2]

com::RuntimeCheckedCommandInvoker invoke ( Symbol  cmdID )

inline

Definition at line 130 of file command-invocation.hpp.

References Command::get().

Referenced by invoke(), CommandUse1_test::standardUse(), and CommandUse1_test::undef().

Here is the call graph for this function:

Here is the caller graph for this function:

invoke() [2/2]

com::RuntimeCheckedCommandInvoker invoke ( CStr  cmdID )

inline

Definition at line 140 of file command-invocation.hpp.

References invoke().

Here is the call graph for this function:

operator==()

bool operator== ( Command const &  c1, Command const &  c2  )

inline

Definition at line 301 of file command.hpp.

operator!=()

bool operator!= ( Command const &  c1, Command const &  c2  )

inline

Definition at line 308 of file command.hpp.

operator<()

bool operator< ( Command const &  c1, Command const &  c2  )

inline

allow for sets and associative containers

Definition at line 314 of file command.hpp.

ON_STREAMTYPES_RESET()

CStr ON_STREAMTYPES_RESET

(

"ON_STREAMTYPES_RESET"

)

LifecycleHook, on which all the basic setup and configuration providing the pristine state of the stream type system has to be registered.

Note

plugins providing additional streamtype configuration should register their basic setup functions using this hook, which can be done via the C interface functions

Variable Documentation

ON_STREAMTYPES_RESET

CStr ON_STREAMTYPES_RESET

extern

triggered to load the generic pristine default

Referenced by lumiera_StreamType_registerInitFunction(), and STypeManager::reset().