session-service-mock-index.hpp File Reference

Go to the source code of this file.

Description

Implementation level session API: PlacementIndex mock for tests.

Allows (temporarily) to replace the real Placement index within the session by a mock instance installed and provided through this API. Unit tests may use this backdoor to set up a specially prepared index to verify the behaviour of Placement and Scope resolution operations.

The test/mock instance of the placement index obtained by this API is not wired with the session. Rather it is managed by smart-ptr. When the last smart-ptr instance goes out of scope, the test index instance will be shut down and removed, thereby uncovering the original PlacementIndex living within the session.

See also

session-impl.hpp implementation of the service

session-services.cpp implementation of access

Definition in file session-service-mock-index.hpp.

#include "steam/mobject/session/placement-index.hpp"
#include <memory>

Classes
class	SessionServiceMockIndex
	there is an implicit PlacementIndex available on a global level, by default implemented within the current session. More...

Typedefs
typedef std::shared_ptr< PlacementIndex >	PPIdx

Namespaces
	steam
	Steam-Layer implementation namespace root.
	steam::mobject
	Media-Objects, edit operations and high-level session.
	steam::mobject::session
	Namespace of Session and user visible high-level objects.