cx::Probe Class Reference

US Probe interface. More...

#include <cxProbe.h>

Inheritance diagram for cx::Probe:

Signals
void	sectorChanged ()
	< Return a ProbeSectorPtr for the given uid. Use 'active' to get the default. More...
void	activeConfigChanged ()
void	videoSourceAdded (VideoSourcePtr source)

Public Member Functions
virtual	~Probe ()
virtual bool	isValid () const =0
virtual void	addXml (QDomNode &dataNode)=0
virtual void	parseXml (QDomNode &dataNode)=0
virtual QStringList	getConfigIdList () const =0
virtual QString	getConfigName (QString uid)=0
virtual QString	getConfigId () const =0
virtual QString	getConfigurationPath () const =0
virtual void	removeCurrentConfig ()=0
	remove the current config from disk More...
virtual void	saveCurrentConfig (QString uid, QString name)=0
	save current config to disk under ids (uid,name). More...
virtual void	applyNewConfigurationWithId (QString uid)=0
virtual void	setTemporalCalibration (double val)=0
virtual void	setSoundSpeedCompensationFactor (double val)=0
virtual void	setProbeDefinition (ProbeDefinition probeDefinition)=0
virtual void	setRTSource (VideoSourcePtr source)=0
virtual void	removeRTSource (VideoSourcePtr source)=0
virtual void	setActiveStream (QString uid)=0
virtual QString	getActiveStream () const =0
virtual QStringList	getAvailableVideoSources ()=0
	Return a list of all available video source. The default is one with uid=='active'. More...
virtual VideoSourcePtr	getRTSource (QString uid="active") const =0
	Return a VideoSource for the given uid. Use 'active' to get the default stream. More...
virtual ProbeDefinition	getProbeDefinition (QString uid="active") const =0
	Return a ProbeDefinition for the given uid. Use 'active' to get the default. More...
virtual ProbeSectorPtr	getSector (QString uid="active")=0

Detailed Description

US Probe interface.

Available from Tool when Tool is a Probe.

Definition at line 32 of file cxProbe.h.

Constructor & Destructor Documentation

virtual cx::Probe::~Probe ( )

inlinevirtual

Definition at line 36 of file cxProbe.h.

Member Function Documentation

void cx::Probe::activeConfigChanged ( )

signal

virtual void cx::Probe::addXml ( QDomNode &  dataNode )

pure virtual

Implemented in cx::DummyProbe, and cx::ProbeImpl.

virtual void cx::Probe::applyNewConfigurationWithId ( QString  uid )

pure virtual

Implemented in cx::DummyProbe, and cx::ProbeImpl.

virtual QString cx::Probe::getActiveStream ( ) const

pure virtual

Implemented in cx::ProbeImpl, and cx::DummyProbe.

virtual QStringList cx::Probe::getAvailableVideoSources ( )

pure virtual

Return a list of all available video source. The default is one with uid=='active'.

Implemented in cx::ProbeImpl, and cx::DummyProbe.

virtual QString cx::Probe::getConfigId ( ) const

pure virtual

Implemented in cx::DummyProbe, and cx::ProbeImpl.

virtual QStringList cx::Probe::getConfigIdList ( ) const

pure virtual

Implemented in cx::DummyProbe, and cx::ProbeImpl.

virtual QString cx::Probe::getConfigName ( QString  uid )

pure virtual

Implemented in cx::DummyProbe, and cx::ProbeImpl.

virtual QString cx::Probe::getConfigurationPath ( ) const

pure virtual

Implemented in cx::DummyProbe, and cx::ProbeImpl.

virtual ProbeDefinition cx::Probe::getProbeDefinition ( QString  uid = "active" ) const

pure virtual

Return a ProbeDefinition for the given uid. Use 'active' to get the default.

Implemented in cx::ProbeImpl, and cx::DummyProbe.

virtual VideoSourcePtr cx::Probe::getRTSource ( QString  uid = "active" ) const

pure virtual

Return a VideoSource for the given uid. Use 'active' to get the default stream.

Implemented in cx::DummyProbe, and cx::ProbeImpl.

virtual ProbeSectorPtr cx::Probe::getSector ( QString  uid = "active" )

pure virtual

Implemented in cx::ProbeImpl, and cx::DummyProbe.

virtual bool cx::Probe::isValid ( ) const

pure virtual

Implemented in cx::ProbeImpl, and cx::DummyProbe.

virtual void cx::Probe::parseXml ( QDomNode &  dataNode )

pure virtual

Implemented in cx::DummyProbe, and cx::ProbeImpl.

virtual void cx::Probe::removeCurrentConfig ( )

pure virtual

remove the current config from disk

Implemented in cx::ProbeImpl, and cx::DummyProbe.

virtual void cx::Probe::removeRTSource ( VideoSourcePtr  source )

pure virtual

Implemented in cx::DummyProbe, and cx::ProbeImpl.

virtual void cx::Probe::saveCurrentConfig ( QString  uid, QString  name  )

pure virtual

save current config to disk under ids (uid,name).

Implemented in cx::ProbeImpl, and cx::DummyProbe.

void cx::Probe::sectorChanged ( )

signal

< Return a ProbeSectorPtr for the given uid. Use 'active' to get the default.

virtual void cx::Probe::setActiveStream ( QString  uid )

pure virtual

Implemented in cx::ProbeImpl, and cx::DummyProbe.

virtual void cx::Probe::setProbeDefinition ( ProbeDefinition  probeDefinition )

pure virtual

Implemented in cx::DummyProbe, and cx::ProbeImpl.

virtual void cx::Probe::setRTSource ( VideoSourcePtr  source )

pure virtual

Implemented in cx::DummyProbe, and cx::ProbeImpl.

virtual void cx::Probe::setSoundSpeedCompensationFactor ( double  val )

pure virtual

Implemented in cx::DummyProbe, and cx::ProbeImpl.

virtual void cx::Probe::setTemporalCalibration ( double  val )

pure virtual

Implemented in cx::DummyProbe, and cx::ProbeImpl.

void cx::Probe::videoSourceAdded ( VideoSourcePtr  source )

signal

---

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

• /media/jenkins/bamboo/buildagent/xml-data/build-dir/FX-OSTBR-JOB1/CX/CX/source/resource/core/Tool/cxProbe.h