Simulated Reality SDK 7500c78d v1.30.2.51085 2024-04-26T11:23:03Z
Stable
Public Types | Public Member Functions | List of all members
SR::SystemEventStream Class Reference

Stream of SR_systemEvent objects. More...

#include <systemeventstream.h>

Public Types

using Frame = SystemEvent
 Used in OutputStreams template. More...
 

Public Member Functions

 SystemEventStream (SystemSense *sense, SystemEventListener *listener)
 Construct a new SystemEventStream. More...
 
 ~SystemEventStream ()
 
void stopListening ()
 Stop listening and notify sense to stop sending new frames. (Called by listener) More...
 
void close ()
 Close the stream. (Called by sense) More...
 
void update (SystemEvent frame)
 Send new frame to listener. More...
 

Detailed Description

Stream of SR_systemEvent objects.

Connects a SystemSense to a SystemEventListener object.

Member Typedef Documentation

◆ Frame

Used in OutputStreams template.

Constructor & Destructor Documentation

◆ SystemEventStream()

SR::SystemEventStream::SystemEventStream ( SystemSense sense,
SystemEventListener listener 
)

Construct a new SystemEventStream.

Parameters
senserefers to the SystemSense providing updates
listenerrefers to the SystemEventListener receiving updates

Called by the SystemSense when requested for an SystemEventListener through an openSystemEventStream call.

◆ ~SystemEventStream()

SR::SystemEventStream::~SystemEventStream ( )

Member Function Documentation

◆ close()

void SR::SystemEventStream::close ( )

Close the stream. (Called by sense)

◆ stopListening()

void SR::SystemEventStream::stopListening ( )

Stop listening and notify sense to stop sending new frames. (Called by listener)

◆ update()

void SR::SystemEventStream::update ( SystemEvent  frame)

Send new frame to listener.

Parameters
framerepresents a single update

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