Description

Lumiera public interface.

Global interfaces and facilities accessible from plugins and scripts. It's probably a good idea to pull it in explicitly and to avoid nesting implementation namespaces within lumiera::

Namespaces
namespace	advice

namespace	anonymous_namespace{appstate.cpp}

namespace	anonymous_namespace{basic-setup.cpp}

namespace	anonymous_namespace{configfacade.cpp}

namespace	anonymous_namespace{instancehandle.hpp}

namespace	anonymous_namespace{nobug-init.hpp}

namespace	anonymous_namespace{query.hpp}

namespace	anonymous_namespace{subsystem-runner.hpp}

namespace	error

namespace	facade

namespace	query

namespace	test

namespace	visitor_concept_draft

Typedefs
typedef AppState::ExitCode	ExitCode

typedef std::shared_ptr< Resolution >	PReso
	Allow to take ownership of a result set.

typedef Goal::QueryID const &	QID

typedef MultiFact< Resolution *(Goal const &), Goal::QueryID, BuildRefcountPtr >	DispatcherTable
	factory used as dispatcher table for resolving typed queries

using	Callback = LifecycleRegistry::Hook

using	WrapperPtr = lib::VariantO< steam::WrapperTypes, util::AccessCasted_O >
	helper to treat various sorts of smart-ptrs uniformly.

Enumerations
enum	DisplayerInput { DISPLAY_NONE , DISPLAY_YUV , DISPLAY_RGB , DISPLAY_BGR , DISPLAY_BGR0 , DISPLAY_RGB16 }
	Supported Displayer formats. More...

Classes
class	AppState
	The Lumiera Application state and basic initialisation. More...

class	BasicSetup
	Represents the elementary self-configuration of a running Lumiera application instance. More...

class	Config
	C++ wrapper for convenient access to the Lumiera config system. More...

class	Error
	Interface and Base definition for all Lumiera Exceptions. More...

class	FrameID
	Identification tuple for addressing frames unambiguously. More...

class	Goal
	Query ABC: unspecific goal for resolution or retrieval. More...

class	InstanceHandle
	Handle tracking the registration of an interface, deregistering it on deletion. More...

class	LifecycleHook
	define and register a callback for a specific lifecycle event. More...

class	LifecycleRegistry
	Registry of callback functions accessible by a label (ID) provided at registration. More...

struct	NodeID
	Identification tuple for denoting render nodes unambiguously. More...

class	Option
	Frontend for handling the Lumiera application commandline arguments. More...

class	Play
	Interface to the Player subsystem of Lumiera (Steam-Layer). More...

class	Query
	Generic interface to express a query for specifically typed result elements exposing some capabilities or fulfilling some properties. More...

class	QueryDispatcher
	PImpl of the generic QueryResolver. More...

class	QueryKey
	Wrapper for indexing and ordering. More...

class	QueryResolver
	Interface: a facility for resolving (some kind of) queries A concrete subclass has the ability to create Resolution instances in response to specific queries of some kind, if applicable. More...

class	Resolution
	ABC representing the result set of an individual query resolution. More...

class	Subsys
	Dependencies and lifecycle of a partially independent Subsystem of the Application. More...

class	SubsystemRunner
	Implementation helper for managing execution of a collection of subsystems, which may depend on one another and execute in parallel. More...

Functions
ostream &	operator<< (ostream &os, const Option &to)
	for outputting the help messages.

void	throwOnError ()
	Check the lumiera error state, which maybe was set by C-code.

template<class EX >
void	maybeThrow (string description="")
	Check the lumiera error state and throw a specific exception in case a non-cleared errorflag is detected.

CStr	ON_BASIC_INIT ("ON_BASIC_INIT")

CStr	ON_GLOBAL_INIT ("ON_GLOBAL_INIT")

CStr	ON_GLOBAL_SHUTDOWN ("ON_GLOBAL_SHUTDOWN")

CStr	ON_EMERGENCY ("ON_EMERGENCY")

void	initialise_NoBug ()

Variables
CStr	ON_BASIC_INIT
	automatic static init. treated specially to run as soon as possible

CStr	ON_GLOBAL_INIT
	to be triggered in main()

CStr	ON_GLOBAL_SHUTDOWN
	to be triggered at the end of main()

CStr	ON_EMERGENCY
	activated on shutdown after premature failure of a subsystem

Typedef Documentation

◆ ExitCode

typedef AppState::ExitCode ExitCode

Definition at line 136 of file appstate.cpp.

◆ PReso

typedef std::shared_ptr< Resolution > PReso

Allow to take ownership of a result set.

Allow to take and transfer ownership of a result set.

Definition at line 106 of file query.hpp.

◆ QID

typedef Goal::QueryID const& QID

Definition at line 44 of file query-resolver.cpp.

◆ DispatcherTable

typedef MultiFact< Resolution*(Goal const&) , Goal::QueryID , BuildRefcountPtr > DispatcherTable

factory used as dispatcher table for resolving typed queries

Definition at line 62 of file query-resolver.cpp.

◆ Callback

using Callback = LifecycleRegistry::Hook

Definition at line 51 of file lifecycle.cpp.

◆ WrapperPtr

using WrapperPtr = lib::VariantO<steam::WrapperTypes, util::AccessCasted_O>

helper to treat various sorts of smart-ptrs uniformly.

Implemented as a variant-type value object, it is preconfigured with the possible hierarchy-base classes used within this application. Thus, when passing in an arbitrary smart-ptr, the best fitting smart-ptr type pointing to the corresponding base class is selected for internal storage. Later on, stored values can be retrieved either utilising static or dynamic casts; error reporting is similar to the behaviour of dynamic_cast<T>: when retrieving a pointer, NULL is returned in case of mismatch.

Deprecated:: not sure if this was a good idea anyway. Better re-think how to handle wrapped objects in visitation

Todo:: really need to switch to the new lib::Variant and util::AccessCasted implementation ////////////////TICKET #450

Definition at line 61 of file wrapperptr.hpp.

Enumeration Type Documentation

◆ DisplayerInput

enum DisplayerInput

Supported Displayer formats.

Enumerator
DISPLAY_NONE
DISPLAY_YUV
DISPLAY_RGB
DISPLAY_BGR
DISPLAY_BGR0
DISPLAY_RGB16

Definition at line 43 of file display-handles.hpp.

Function Documentation

◆ operator<<()

ostream & operator<<	(	ostream &	os,
		const Option &	to
	)

for outputting the help messages.

Forward accumulated help messages from all contained option definitions

Definition at line 150 of file option.cpp.

◆ throwOnError()

void throwOnError ( )

inline

Check the lumiera error state, which maybe was set by C-code.

Exceptions

Errorflag exception to signal an detected lumiera error

Note: specific error code and information is enclosed in the raised exception; the error state is not cleared.

Definition at line 234 of file error.hpp.

References lumiera::error::detailInfo(), and lumiera_error().

Referenced by CommandUse2_test::check_DispatcherInvocation(), ExceptionError_test::detectErrorflag(), and SessionCommandFunction_test::run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maybeThrow()

template<class EX >

void maybeThrow ( string description = "" )

inline

Check the lumiera error state and throw a specific exception in case a non-cleared errorflag is detected.

No-op else.

Exceptions

instance of the lumiera::Error subclass provided as template parameter, containing an lumiera::error::Flag as root cause to denote the detected error-flag state.

Definition at line 250 of file error.hpp.

References lumiera::error::detailInfo(), and lumiera_error().

Here is the call graph for this function:

◆ ON_BASIC_INIT()

CStr ON_BASIC_INIT ( "ON_BASIC_INIT" )

◆ ON_GLOBAL_INIT()

CStr ON_GLOBAL_INIT ( "ON_GLOBAL_INIT" )

◆ ON_GLOBAL_SHUTDOWN()

CStr ON_GLOBAL_SHUTDOWN ( "ON_GLOBAL_SHUTDOWN" )

◆ ON_EMERGENCY()

CStr ON_EMERGENCY ( "ON_EMERGENCY" )

◆ initialise_NoBug()

void initialise_NoBug ( )

Definition at line 32 of file nobug-init.cpp.

Variable Documentation

◆ ON_BASIC_INIT

CStr ON_BASIC_INIT

extern

automatic static init. treated specially to run as soon as possible

Referenced by LifecycleRegistry::LifecycleRegistry(), and LifecycleHook::add().

◆ ON_GLOBAL_INIT

CStr ON_GLOBAL_INIT

extern

to be triggered in main()

Note: no magic!

Referenced by AppState::init().

◆ ON_GLOBAL_SHUTDOWN

CStr ON_GLOBAL_SHUTDOWN

extern

to be triggered at the end of main()

Note: no magic!

Referenced by AppState::abort(), and AppState::maybeWait().

◆ ON_EMERGENCY

CStr ON_EMERGENCY

extern

activated on shutdown after premature failure of a subsystem

Referenced by AppState::abort(), and AppState::maybeWait().

Description

Namespaces

Typedefs

Enumerations

Classes

Functions

Variables

Typedef Documentation

◆ ExitCode

◆ PReso

◆ QID

◆ DispatcherTable

◆ Callback

◆ WrapperPtr

Enumeration Type Documentation

◆ DisplayerInput

Function Documentation

◆ operator<<()

◆ throwOnError()

◆ maybeThrow()

◆ ON_BASIC_INIT()

◆ ON_GLOBAL_INIT()

◆ ON_GLOBAL_SHUTDOWN()

◆ ON_EMERGENCY()

◆ initialise_NoBug()

Variable Documentation

◆ ON_BASIC_INIT

◆ ON_GLOBAL_INIT

◆ ON_GLOBAL_SHUTDOWN

◆ ON_EMERGENCY