cx::VideoSource Class Reference

video source interface. More...

#include <cxVideoSource.h>

Inheritance diagram for cx::VideoSource:

Signals
void	streaming (bool on)
	emitted when streaming started/stopped More...
void	connected (bool on)
	emitted when source is connected/disconnected More...
void	newFrame ()
	emitted when a new frame has arrived (getVtkImageData() returns something new). info/status/name/valid might also have changed More...

Public Member Functions
virtual	~VideoSource ()
virtual QString	getUid ()=0
virtual QString	getName ()=0
virtual vtkImageDataPtr	getVtkImageData ()=0
virtual double	getTimestamp ()=0
virtual TimeInfo	getAdvancedTimeInfo ()=0
virtual QString	getInfoString () const =0
	an information text intended to be visible along with the data stream at all times More...
virtual QString	getStatusString () const =0
	status text describing the stream state, display instead of stream when the stream is invalid. More...
virtual void	start ()=0
	start streaming More...
virtual void	stop ()=0
	stop streaming More...
virtual bool	validData () const =0
	return true is data stream is ok to display. This is a heuristic based on the data rate. More...
virtual bool	isConnected () const =0
	return true when a connection to the data source is established. More...
virtual bool	isStreaming () const =0
	return true when the source is streaming data. More...
virtual void	setResolution (double mmPerPixel)

Detailed Description

video source interface.

Synchronize data with source, provide data as a vtkImageData.

Definition at line 43 of file cxVideoSource.h.

Constructor & Destructor Documentation

virtual cx::VideoSource::~VideoSource ( )

inlinevirtual

Definition at line 48 of file cxVideoSource.h.

Member Function Documentation

void cx::VideoSource::connected ( bool  on )

signal

emitted when source is connected/disconnected

virtual TimeInfo cx::VideoSource::getAdvancedTimeInfo ( )

pure virtual

Implemented in cx::BasicVideoSource, cx::TestVideoSource, cx::ProbeAdapterRTSource, and cx::LayoutVideoSource.

virtual QString cx::VideoSource::getInfoString ( ) const

pure virtual

an information text intended to be visible along with the data stream at all times

Implemented in cx::VideoSourceSHM, cx::BasicVideoSource, cx::TestVideoSource, cx::ProbeAdapterRTSource, and cx::LayoutVideoSource.

virtual QString cx::VideoSource::getName ( )

pure virtual

Implemented in cx::VideoSourceSHM, cx::BasicVideoSource, cx::TestVideoSource, cx::ProbeAdapterRTSource, and cx::LayoutVideoSource.

virtual QString cx::VideoSource::getStatusString ( ) const

pure virtual

status text describing the stream state, display instead of stream when the stream is invalid.

Implemented in cx::VideoSourceSHM, cx::BasicVideoSource, cx::TestVideoSource, cx::ProbeAdapterRTSource, and cx::LayoutVideoSource.

virtual double cx::VideoSource::getTimestamp ( )

pure virtual

Implemented in cx::VideoSourceSHM, cx::BasicVideoSource, cx::TestVideoSource, cx::ProbeAdapterRTSource, and cx::LayoutVideoSource.

virtual QString cx::VideoSource::getUid ( )

pure virtual

Implemented in cx::VideoSourceSHM, cx::BasicVideoSource, cx::TestVideoSource, cx::ProbeAdapterRTSource, and cx::LayoutVideoSource.

virtual vtkImageDataPtr cx::VideoSource::getVtkImageData ( )

pure virtual

Implemented in cx::VideoSourceSHM, cx::BasicVideoSource, cx::TestVideoSource, cx::ProbeAdapterRTSource, and cx::LayoutVideoSource.

virtual bool cx::VideoSource::isConnected ( ) const

pure virtual

return true when a connection to the data source is established.

Implemented in cx::VideoSourceSHM, cx::BasicVideoSource, cx::TestVideoSource, cx::ProbeAdapterRTSource, and cx::LayoutVideoSource.

virtual bool cx::VideoSource::isStreaming ( ) const

pure virtual

return true when the source is streaming data.

Implemented in cx::VideoSourceSHM, cx::BasicVideoSource, cx::TestVideoSource, cx::ProbeAdapterRTSource, and cx::LayoutVideoSource.

void cx::VideoSource::newFrame ( )

signal

emitted when a new frame has arrived (getVtkImageData() returns something new). info/status/name/valid might also have changed

virtual void cx::VideoSource::setResolution ( double  mmPerPixel )

inlinevirtual

Set the resolution of the incoming video in mm/pixel

Reimplemented in cx::VideoSourceSHM, cx::BasicVideoSource, and cx::TestVideoSource.

Definition at line 69 of file cxVideoSource.h.

virtual void cx::VideoSource::start ( )

pure virtual

start streaming

Implemented in cx::VideoSourceSHM, cx::BasicVideoSource, cx::TestVideoSource, cx::ProbeAdapterRTSource, and cx::LayoutVideoSource.

virtual void cx::VideoSource::stop ( )

pure virtual

stop streaming

Implemented in cx::VideoSourceSHM, cx::BasicVideoSource, cx::TestVideoSource, cx::ProbeAdapterRTSource, and cx::LayoutVideoSource.

void cx::VideoSource::streaming ( bool  on )

signal

emitted when streaming started/stopped

virtual bool cx::VideoSource::validData ( ) const

pure virtual

return true is data stream is ok to display. This is a heuristic based on the data rate.

Implemented in cx::VideoSourceSHM, cx::BasicVideoSource, cx::TestVideoSource, cx::ProbeAdapterRTSource, and cx::LayoutVideoSource.

---

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

• /media/jenkins/bamboo/buildagent/xml-data/build-dir/CX-NI-JOB1/CX/CX/source/resource/core/Video/cxVideoSource.h