engine::StateAdapter Class Reference

#include <nodeinvocation.hpp>

Inheritance diagram for engine::StateAdapter:

[legend]

Collaboration diagram for engine::StateAdapter:

[legend]

List of all members.

Detailed Description

Adapter to shield the ProcNode from the actual buffer management, allowing the processing function within ProcNode to use logical buffer IDs.

StateAdapter is created on the stack for each pull() call, using setup/wiring data preconfigured by the builder. Its job is to provide the actual implementation of the Cache push / fetch and recursive downcall to render the source frames.

Definition at line 75 of file nodeinvocation.hpp.


Public Member Functions
virtual BuffHandle	fetch (FrameID const &fID)
	try to fetch an existing buffer containing the denoted frame from a cache or similar backing system (e.g.
virtual BuffTableStorage &	getBuffTableStorage ()
	necessary for creating a local BuffTableChunk
virtual void	is_calculated (BuffHandle const &bh)
	declare the data contained in the Buffer to be ready.
virtual void	releaseBuffer (BuffHandle &bh)
	resign control of the buffer denoted by the handle
Protected Member Functions
virtual State &	getCurrentImplementation ()
	resolves to the State object currently "in charge".
	StateAdapter (State &callingProcess)
Protected Attributes
State &	current_
State &	parent_

Member Function Documentation

virtual BuffHandle engine::StateAdapter::fetch ( FrameID const & ) [inline, virtual]

try to fetch an existing buffer containing the denoted frame from a cache or similar backing system (e.g.

network peer).

Returns:: either a handle to a readonly buffer, or a null handle

Note:: the client is responsible for not modifying the provided data

Implements engine::State.

Definition at line 97 of file nodeinvocation.hpp.

References engine::State::fetch().

Here is the call graph for this function:

virtual BuffTableStorage& engine::StateAdapter::getBuffTableStorage ( ) [inline, virtual]

necessary for creating a local BuffTableChunk

Implements engine::State.

Definition at line 99 of file nodeinvocation.hpp.

References engine::State::getBuffTableStorage().

Here is the call graph for this function:

virtual State& engine::StateAdapter::getCurrentImplementation ( ) [inline, protected, virtual]

resolves to the State object currently "in charge".

Intended as a performance shortcut to avoid calling up through a chain of virtual functions when deep down in chained ProcNode::pull() calls. This allows derived classes to proxy the state interface.

Implements engine::State.

Definition at line 87 of file nodeinvocation.hpp.

virtual void engine::StateAdapter::is_calculated ( BuffHandle const & ) [inline, virtual]

declare the data contained in the Buffer to be ready.

The caller is required to restrain itself from modifying the data afterwards, as this buffer now can be used (readonly) by other calculation processes in parallel.

Implements engine::State.

Definition at line 95 of file nodeinvocation.hpp.

References engine::State::is_calculated().

Here is the call graph for this function: