Sense class which shares information about the SR system throughout the SR system and to applications. More...

Inheritance diagram for SR::SystemSense:

Collaboration diagram for SR::SystemSense:

Public Member Functions
virtual std::shared_ptr< SystemEventStream >	openSystemEventStream (SystemEventListener *listener)=0
	Creates a SystemEventStream for `listener` to be connected to. More...

virtual void	streamClosed (SystemEventStream *stream)=0
	Closes a specific SystemEventStream. More...

Public Member Functions inherited from SR::Sense
void	setCalibration (Transformation calibration)
	Sets a Transformation object to represent the sense's calibration with respect to the display. More...

Transformation	getCalibration ()
	Gets callibration. More...

virtual	~Sense ()
	Ensures the proper destruction of the sense implementation. More...

virtual std::string	getName ()=0
	Return the name of the sense. More...

virtual std::string	getDescription ()=0
	Return a description of the sense. More...

virtual void	start ()=0
	Start continuous updates, default behaviour is defined in the updater() function. More...

virtual void	stop ()=0
	Stop continuous updates. More...

Static Public Member Functions
static SystemSense *	create (SRContext &context)
	Creates a functional SystemSense instance. More...

Additional Inherited Members
Protected Attributes inherited from SR::Sense
Transformation	calibration

Detailed Description

Sense class which shares information about the SR system throughout the SR system and to applications.

Member Function Documentation

static SystemSense * SR::SystemSense::create ( SRContext & context )

static

Creates a functional SystemSense instance.

Parameters

context is the environment in which created senses are kept track of

virtual std::shared_ptr< SystemEventStream > SR::SystemSense::openSystemEventStream ( SystemEventListener * listener )

pure virtual

Creates a SystemEventStream for listener to be connected to.

Parameters

listener will receive system-wide event updates from now on

Returns: std::shared_ptr<SystemEventStream> to be used to close the stream correctly when it is no longer required

virtual void SR::SystemSense::streamClosed ( SystemEventStream * stream )

pure virtual

Closes a specific SystemEventStream.

Parameters

stream will no longer supply SystemEvent updates

The documentation for this class was generated from the following file: