PlusLib  2.9.0
Software library for tracked ultrasound image acquisition, calibration, and processing.
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkPlusIgtlMessageCommon Class Reference
PlusOpenIGTLink

Helper class for OpenIGTLink message generation. More...

#include <src/PlusOpenIGTLink/vtkPlusIgtlMessageCommon.h>

Inheritance diagram for vtkPlusIgtlMessageCommon:
Inheritance graph
[legend]
Collaboration diagram for vtkPlusIgtlMessageCommon:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
virtual void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
 

Static Public Member Functions

static PlusStatus GetIgtlMatrix (igtl::Matrix4x4 &igtlMatrix, vtkIGSIOTransformRepository *transformRepository, igsioTransformName &transformName)
 
static int IsTypeOf (const char *type)
 
static vtkPlusIgtlMessageCommon * New ()
 
static PlusStatus PackImageMessage (igtl::ImageMessage::Pointer imageMessage, igsioTrackedFrame &trackedFrame, const vtkMatrix4x4 &imageToReferenceTransform, vtkIGSIOFrameConverter *frameConverter=NULL)
 
static PlusStatus PackImageMessage (igtl::ImageMessage::Pointer imageMessage, vtkImageData *image, const vtkMatrix4x4 &imageToReferenceTransform, double timestamp)
 
static PlusStatus PackImageMetaMessage (igtl::ImageMetaMessage::Pointer imageMetaMessage, igsioCommon::ImageMetaDataList &imageMetaDataList)
 
static PlusStatus PackPolyDataMessage (igtl::PolyDataMessage::Pointer polydataMessage, vtkSmartPointer< vtkPolyData > polyData, double timestamp)
 
static PlusStatus PackPositionMessage (igtl::PositionMessage::Pointer positionMessage, igsioTransformName &transformName, ToolStatus status, float position[3], float quaternion[4], double timestamp)
 
static PlusStatus PackStringMessage (igtl::StringMessage::Pointer stringMessage, const char *stringName, const char *stringValue, double timestamp)
 
static PlusStatus PackStringMessage (igtl::StringMessage::Pointer stringMessage, const std::string &stringName, const std::string &stringValue, double timestamp)
 
static PlusStatus PackTrackedFrameMessage (igtl::PlusTrackedFrameMessage::Pointer trackedFrameMessage, igsioTrackedFrame &trackedFrame, vtkSmartPointer< vtkMatrix4x4 > embeddedImageTransform, const std::vector< igsioTransformName > &requestedTransforms)
 
static PlusStatus PackTrackingDataMessage (igtl::TrackingDataMessage::Pointer tdataMessage, const std::vector< igsioTransformName > &names, const vtkIGSIOTransformRepository &repository, double timestamp)
 
static PlusStatus PackTransformMessage (igtl::TransformMessage::Pointer transformMessage, igsioTransformName &transformName, igtl::Matrix4x4 &igtlMatrix, ToolStatus status, double timestamp)
 
static PlusStatus PackUsMessage (igtl::PlusUsMessage::Pointer usMessage, igsioTrackedFrame &trackedFrame)
 
static vtkPlusIgtlMessageCommon * SafeDownCast (vtkObject *o)
 
static PlusStatus UnpackImageMessage (igtl::MessageHeader::Pointer headerMsg, igtl::Socket *socket, igsioTrackedFrame &trackedFrame, const igsioTransformName &embeddedTransformName, int crccheck)
 
static PlusStatus UnpackPositionMessage (igtl::MessageHeader::Pointer headerMsg, igtl::Socket *socket, vtkMatrix4x4 *transformMatrix, std::string &transformName, ToolStatus &toolStatus, double &timestamp, int crccheck)
 
static PlusStatus UnpackTrackedFrameMessage (igtl::MessageHeader::Pointer headerMsg, igtl::Socket *socket, igsioTrackedFrame &trackedFrame, const igsioTransformName &embeddedTransformName, int crccheck)
 
static PlusStatus UnpackTrackingDataMessage (igtl::MessageHeader::Pointer headerMsg, igtl::Socket *socket, std::vector< igsioTransformName > &names, vtkIGSIOTransformRepository &repository, double &timestamp, int crccheck)
 
static PlusStatus UnpackTransformMessage (igtl::MessageHeader::Pointer headerMsg, igtl::Socket *socket, vtkMatrix4x4 *transformMatrix, ToolStatus &toolStatus, std::string &transformName, double &timestamp, int crccheck)
 
static PlusStatus UnpackUsMessage (igtl::MessageHeader::Pointer headerMsg, igtl::Socket *socket, igsioTrackedFrame &trackedFrame, int crccheck)
 

Protected Member Functions

 vtkPlusIgtlMessageCommon ()
 
virtual ~vtkPlusIgtlMessageCommon ()
 

Detailed Description

Helper class for OpenIGTLink message generation.

This class is a helper class for OpenIGTLink message pack/unpack

Definition at line 48 of file vtkPlusIgtlMessageCommon.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPlusIgtlMessageCommon::Superclass

Definition at line 52 of file vtkPlusIgtlMessageCommon.h.

Constructor & Destructor Documentation

◆ vtkPlusIgtlMessageCommon()

vtkPlusIgtlMessageCommon::vtkPlusIgtlMessageCommon ( )
protected

Definition at line 40 of file vtkPlusIgtlMessageCommon.cxx.

◆ ~vtkPlusIgtlMessageCommon()

vtkPlusIgtlMessageCommon::~vtkPlusIgtlMessageCommon ( )
protectedvirtual

Definition at line 45 of file vtkPlusIgtlMessageCommon.cxx.

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPlusIgtlMessageCommon::GetClassName ( )
virtual

◆ GetIgtlMatrix()

PlusStatus vtkPlusIgtlMessageCommon::GetIgtlMatrix ( igtl::Matrix4x4 &  igtlMatrix,
vtkIGSIOTransformRepository *  transformRepository,
igsioTransformName &  transformName 
)
static

Generate igtl::Matrix4x4 with the selected transform name from the transform repository

Definition at line 56 of file vtkPlusIgtlMessageCommon.cxx.

◆ IsA()

virtual int vtkPlusIgtlMessageCommon::IsA ( const char *  type)
virtual

◆ IsTypeOf()

static int vtkPlusIgtlMessageCommon::IsTypeOf ( const char *  type)
static

◆ New()

static vtkPlusIgtlMessageCommon* vtkPlusIgtlMessageCommon::New ( )
static

◆ PackImageMessage() [1/2]

PlusStatus vtkPlusIgtlMessageCommon::PackImageMessage ( igtl::ImageMessage::Pointer  imageMessage,
igsioTrackedFrame &  trackedFrame,
const vtkMatrix4x4 &  imageToReferenceTransform,
vtkIGSIOFrameConverter *  frameConverter = NULL 
)
static

Pack image message from tracked frame

Definition at line 219 of file vtkPlusIgtlMessageCommon.cxx.

◆ PackImageMessage() [2/2]

PlusStatus vtkPlusIgtlMessageCommon::PackImageMessage ( igtl::ImageMessage::Pointer  imageMessage,
vtkImageData *  image,
const vtkMatrix4x4 &  imageToReferenceTransform,
double  timestamp 
)
static

Pack image message from vtkImageData volume

Definition at line 299 of file vtkPlusIgtlMessageCommon.cxx.

◆ PackImageMetaMessage()

PlusStatus vtkPlusIgtlMessageCommon::PackImageMetaMessage ( igtl::ImageMetaMessage::Pointer  imageMetaMessage,
igsioCommon::ImageMetaDataList &  imageMetaDataList 
)
static

Pack image meta deta message from vtkPlusServer::ImageMetaDataList

Definition at line 446 of file vtkPlusIgtlMessageCommon.cxx.

◆ PackPolyDataMessage()

PlusStatus vtkPlusIgtlMessageCommon::PackPolyDataMessage ( igtl::PolyDataMessage::Pointer  polydataMessage,
vtkSmartPointer< vtkPolyData >  polyData,
double  timestamp 
)
static

Pack poly data message from polydata

Definition at line 612 of file vtkPlusIgtlMessageCommon.cxx.

◆ PackPositionMessage()

PlusStatus vtkPlusIgtlMessageCommon::PackPositionMessage ( igtl::PositionMessage::Pointer  positionMessage,
igsioTransformName &  transformName,
ToolStatus  status,
float  position[3],
float  quaternion[4],
double  timestamp 
)
static

Pack position message from tracked frame

Definition at line 856 of file vtkPlusIgtlMessageCommon.cxx.

◆ PackStringMessage() [1/2]

PlusStatus vtkPlusIgtlMessageCommon::PackStringMessage ( igtl::StringMessage::Pointer  stringMessage,
const char *  stringName,
const char *  stringValue,
double  timestamp 
)
static

Pack string message

Definition at line 973 of file vtkPlusIgtlMessageCommon.cxx.

◆ PackStringMessage() [2/2]

PlusStatus vtkPlusIgtlMessageCommon::PackStringMessage ( igtl::StringMessage::Pointer  stringMessage,
const std::string &  stringName,
const std::string &  stringValue,
double  timestamp 
)
static

Definition at line 996 of file vtkPlusIgtlMessageCommon.cxx.

◆ PackTrackedFrameMessage()

PlusStatus vtkPlusIgtlMessageCommon::PackTrackedFrameMessage ( igtl::PlusTrackedFrameMessage::Pointer  trackedFrameMessage,
igsioTrackedFrame &  trackedFrame,
vtkSmartPointer< vtkMatrix4x4 >  embeddedImageTransform,
const std::vector< igsioTransformName > &  requestedTransforms 
)
static

Pack tracked frame message from tracked frame

Definition at line 89 of file vtkPlusIgtlMessageCommon.cxx.

◆ PackTrackingDataMessage()

PlusStatus vtkPlusIgtlMessageCommon::PackTrackingDataMessage ( igtl::TrackingDataMessage::Pointer  tdataMessage,
const std::vector< igsioTransformName > &  names,
const vtkIGSIOTransformRepository &  repository,
double  timestamp 
)
static

Pack data message from tracked frame

Definition at line 633 of file vtkPlusIgtlMessageCommon.cxx.

◆ PackTransformMessage()

PlusStatus vtkPlusIgtlMessageCommon::PackTransformMessage ( igtl::TransformMessage::Pointer  transformMessage,
igsioTransformName &  transformName,
igtl::Matrix4x4 &  igtlMatrix,
ToolStatus  status,
double  timestamp 
)
static

Pack transform message from tracked frame

Definition at line 574 of file vtkPlusIgtlMessageCommon.cxx.

◆ PackUsMessage()

PlusStatus vtkPlusIgtlMessageCommon::PackUsMessage ( igtl::PlusUsMessage::Pointer  usMessage,
igsioTrackedFrame &  trackedFrame 
)
static

Pack US message from tracked frame

Definition at line 166 of file vtkPlusIgtlMessageCommon.cxx.

◆ PrintSelf()

void vtkPlusIgtlMessageCommon::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

Definition at line 50 of file vtkPlusIgtlMessageCommon.cxx.

◆ SafeDownCast()

static vtkPlusIgtlMessageCommon* vtkPlusIgtlMessageCommon::SafeDownCast ( vtkObject *  o)
static

◆ UnpackImageMessage()

PlusStatus vtkPlusIgtlMessageCommon::UnpackImageMessage ( igtl::MessageHeader::Pointer  headerMsg,
igtl::Socket *  socket,
igsioTrackedFrame &  trackedFrame,
const igsioTransformName &  embeddedTransformName,
int  crccheck 
)
static

Unpack image message to tracked frame

Definition at line 359 of file vtkPlusIgtlMessageCommon.cxx.

◆ UnpackPositionMessage()

PlusStatus vtkPlusIgtlMessageCommon::UnpackPositionMessage ( igtl::MessageHeader::Pointer  headerMsg,
igtl::Socket *  socket,
vtkMatrix4x4 *  transformMatrix,
std::string &  transformName,
ToolStatus &  toolStatus,
double &  timestamp,
int  crccheck 
)
static

Unpack position message

Definition at line 886 of file vtkPlusIgtlMessageCommon.cxx.

◆ UnpackTrackedFrameMessage()

PlusStatus vtkPlusIgtlMessageCommon::UnpackTrackedFrameMessage ( igtl::MessageHeader::Pointer  headerMsg,
igtl::Socket *  socket,
igsioTrackedFrame &  trackedFrame,
const igsioTransformName &  embeddedTransformName,
int  crccheck 
)
static

Unpack tracked frame message to tracked frame

Definition at line 117 of file vtkPlusIgtlMessageCommon.cxx.

◆ UnpackTrackingDataMessage()

PlusStatus vtkPlusIgtlMessageCommon::UnpackTrackingDataMessage ( igtl::MessageHeader::Pointer  headerMsg,
igtl::Socket *  socket,
std::vector< igsioTransformName > &  names,
vtkIGSIOTransformRepository &  repository,
double &  timestamp,
int  crccheck 
)
static

Unpack data message

Definition at line 689 of file vtkPlusIgtlMessageCommon.cxx.

◆ UnpackTransformMessage()

PlusStatus vtkPlusIgtlMessageCommon::UnpackTransformMessage ( igtl::MessageHeader::Pointer  headerMsg,
igtl::Socket *  socket,
vtkMatrix4x4 *  transformMatrix,
ToolStatus &  toolStatus,
std::string &  transformName,
double &  timestamp,
int  crccheck 
)
static

Unpack transform message

Definition at line 775 of file vtkPlusIgtlMessageCommon.cxx.

◆ UnpackUsMessage()

PlusStatus vtkPlusIgtlMessageCommon::UnpackUsMessage ( igtl::MessageHeader::Pointer  headerMsg,
igtl::Socket *  socket,
igsioTrackedFrame &  trackedFrame,
int  crccheck 
)
static

Unpack US message to tracked frame

Definition at line 181 of file vtkPlusIgtlMessageCommon.cxx.

The documentation for this class was generated from the following files:
Generated on Tue Apr 23 2024 01:44:49 for PlusLib by   doxygen 1.8.15