Fraxinus  16.5.0-fx-rc3
An IGT application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cx::Protocol Class Referenceabstract

#include <cxProtocol.h>

Inheritance diagram for cx::Protocol:
cx::OpenIGTLinkProtocol cx::CustusProtocol cx::PlusProtocol cx::RASProtocol

Signals

void transform (QString devicename, Transform3D transform, double timestamp)
 
void calibration (QString devicename, Transform3D calibration)
 
void image (ImagePtr image)
 
void mesh (MeshPtr mesh)
 
void probedefinition (QString devicename, ProbeDefinitionPtr definition)
 

Public Member Functions

 Protocol (QObject *parent=0)
 
virtual QString getName () const
 
virtual EncodedPackagePtr getPack ()
 
virtual bool readyToReceiveData ()=0
 
virtual EncodedPackagePtr encode (ImagePtr image)=0
 
virtual EncodedPackagePtr encode (MeshPtr data)=0
 
virtual void setSynchronizeRemoteClock (bool on)
 

Protected Slots

virtual void processPack ()=0
 

Protected Attributes

EncodedPackagePtr mPack
 
StreamedTimestampSynchronizerPtr mStreamSynchronizer
 

Detailed Description

An Application layer protocol for sending/receiving CustusX objects.

Single-threaded.

Definition at line 56 of file cxProtocol.h.

Constructor & Destructor Documentation

cx::Protocol::Protocol ( QObject *  parent = 0)
explicit

Definition at line 11 of file cxProtocol.cpp.

Member Function Documentation

void cx::Protocol::calibration ( QString  devicename,
Transform3D  calibration 
)
signal
virtual EncodedPackagePtr cx::Protocol::encode ( ImagePtr  image)
pure virtual

Implemented in cx::OpenIGTLinkProtocol.

virtual EncodedPackagePtr cx::Protocol::encode ( MeshPtr  data)
pure virtual

Implemented in cx::OpenIGTLinkProtocol.

QString cx::Protocol::getName ( ) const
virtual

Reimplemented in cx::PlusProtocol, cx::CustusProtocol, and cx::RASProtocol.

Definition at line 19 of file cxProtocol.cpp.

EncodedPackagePtr cx::Protocol::getPack ( )
virtual

Definition at line 24 of file cxProtocol.cpp.

void cx::Protocol::image ( ImagePtr  image)
signal
void cx::Protocol::mesh ( MeshPtr  mesh)
signal
void cx::Protocol::probedefinition ( QString  devicename,
ProbeDefinitionPtr  definition 
)
signal
virtual void cx::Protocol::processPack ( )
protectedpure virtualslot
virtual bool cx::Protocol::readyToReceiveData ( )
pure virtual

Implemented in cx::OpenIGTLinkProtocol.

void cx::Protocol::setSynchronizeRemoteClock ( bool  on)
virtual

Assume the clock on the remote side is not synced, take steps to synchronize incoming timestamps if needed.

Definition at line 29 of file cxProtocol.cpp.

void cx::Protocol::transform ( QString  devicename,
Transform3D  transform,
double  timestamp 
)
signal

Member Data Documentation

EncodedPackagePtr cx::Protocol::mPack
protected

Definition at line 84 of file cxProtocol.h.

StreamedTimestampSynchronizerPtr cx::Protocol::mStreamSynchronizer
protected

Definition at line 85 of file cxProtocol.h.


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