CustusX  2023.01.05-dev+develop.0da12
An IGT application
Public Member Functions | List of all members
cx::LayoutVideoSource Class Reference

#include <cxLayoutVideoSource.h>

Inheritance diagram for cx::LayoutVideoSource:
cx::VideoSource

Public Member Functions

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

Additional Inherited Members

- Signals inherited from cx::VideoSource
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...
 

Detailed Description

Stream images rendered to the input ViewCollectionWidget.

Definition at line 25 of file cxLayoutVideoSource.h.

Constructor & Destructor Documentation

cx::LayoutVideoSource::LayoutVideoSource ( ViewCollectionWidget *  widget)
explicit

Definition at line 20 of file cxLayoutVideoSource.cpp.

Member Function Documentation

TimeInfo cx::LayoutVideoSource::getAdvancedTimeInfo ( )
virtual

Implements cx::VideoSource.

Definition at line 43 of file cxLayoutVideoSource.cpp.

virtual QString cx::LayoutVideoSource::getInfoString ( ) const
inlinevirtual

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

Implements cx::VideoSource.

Definition at line 38 of file cxLayoutVideoSource.h.

QString cx::LayoutVideoSource::getName ( )
virtual

Implements cx::VideoSource.

Definition at line 33 of file cxLayoutVideoSource.cpp.

virtual QString cx::LayoutVideoSource::getStatusString ( ) const
inlinevirtual

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

Implements cx::VideoSource.

Definition at line 39 of file cxLayoutVideoSource.h.

double cx::LayoutVideoSource::getTimestamp ( )
virtual

Implements cx::VideoSource.

Definition at line 38 of file cxLayoutVideoSource.cpp.

QString cx::LayoutVideoSource::getUid ( )
virtual

Implements cx::VideoSource.

Definition at line 28 of file cxLayoutVideoSource.cpp.

vtkImageDataPtr cx::LayoutVideoSource::getVtkImageData ( )
virtual

Implements cx::VideoSource.

Definition at line 92 of file cxLayoutVideoSource.cpp.

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

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

Implements cx::VideoSource.

Definition at line 72 of file cxLayoutVideoSource.cpp.

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

return true when the source is streaming data.

Implements cx::VideoSource.

Definition at line 77 of file cxLayoutVideoSource.cpp.

void cx::LayoutVideoSource::start ( )
virtual

start streaming

Implements cx::VideoSource.

Definition at line 48 of file cxLayoutVideoSource.cpp.

void cx::LayoutVideoSource::stop ( )
virtual

stop streaming

Implements cx::VideoSource.

Definition at line 57 of file cxLayoutVideoSource.cpp.

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

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

Implements cx::VideoSource.

Definition at line 67 of file cxLayoutVideoSource.cpp.

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