VuoRunnerDelegate Class Reference

Description

An abstract class to be implemented by a client that will receive telemetry data from the graph.

Inherit from this class if you want to implement all of the delegate methods. If you'd only like to implement some delegate methods, inherit from VuoRunnerDelegateAdapter.

Public Member Functions
virtual void	receivedTelemetryStats (unsigned long utime, unsigned long stime)=0
	This delegate method is invoked twice per second, to provide a heartbeat indicating that the composition is still alive.
virtual void	receivedTelemetryNodeExecutionStarted (string nodeIdentifier)=0
	This delegate method is invoked every time a node has started executing.
virtual void	receivedTelemetryNodeExecutionFinished (string nodeIdentifier)=0
	This delegate method is invoked every time a node has finished executing.
virtual void	receivedTelemetryEdgeHit (string edgeIdentifier)=0
	This delegate method is invoked every time an event has traversed a cable.
virtual void	receivedTelemetryPortValueChanged (string portIdentifier, string valueAsString)=0
	This delegate method is invoked every time any output port value has changed.
virtual void	receivedTelemetryPublishedPortValueChanged (VuoPublishedPort *port, string valueAsString)=0
	This delegate method is invoked every time any published output port value has changed.

Member Function Documentation

virtual void VuoRunnerDelegate::receivedTelemetryEdgeHit ( string  edgeIdentifier )

pure virtual

This delegate method is invoked every time an event has traversed a cable.

Parameters

edgeIdentifier

A unique identifier representing the cable that was traversed.

virtual void VuoRunnerDelegate::receivedTelemetryNodeExecutionFinished ( string  nodeIdentifier )

pure virtual

This delegate method is invoked every time a node has finished executing.

Parameters

nodeIdentifier

A unique identifier representing the node that finished executing.

virtual void VuoRunnerDelegate::receivedTelemetryNodeExecutionStarted ( string  nodeIdentifier )

pure virtual

This delegate method is invoked every time a node has started executing.

Parameters

nodeIdentifier

A unique identifier representing the node that started executing.

virtual void VuoRunnerDelegate::receivedTelemetryPortValueChanged ( string  portIdentifier, string  valueAsString  )

pure virtual

This delegate method is invoked every time any output port value has changed.

Parameters

portIdentifier	A unique identifier representing the port whose value has changed.
valueAsString	The new value of the port, serialized.

virtual void VuoRunnerDelegate::receivedTelemetryPublishedPortValueChanged ( VuoPublishedPort *  port, string  valueAsString  )

pure virtual

This delegate method is invoked every time any published output port value has changed.

Parameters

port	The VuoPublishedPort whose value has changed (see VuoRunner::getPublishedOutputPorts() and VuoRunner::getPublishedOutputPortWithName()).
valueAsString	The new value of the port, serialized.

virtual void VuoRunnerDelegate::receivedTelemetryStats ( unsigned long  utime, unsigned long  stime  )

pure virtual

This delegate method is invoked twice per second, to provide a heartbeat indicating that the composition is still alive.

It also provides some basic usage stats.

Parameters

utime	The number of microseconds this process has spent in user-mode execution.
stime	The number of microseconds spent in the system executing on behalf of this process.

---

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

• base/VuoRunner.hh
• base/VuoRunner.cc