NorMIT-nav  2023.01.05-dev+develop.0da12
An IGT application
cx::IGTLinkUSStatusMessage Class Reference

IGTLink Message content: More...

#include <cxIGTLinkUSStatusMessage.h>

Inheritance diagram for cx::IGTLinkUSStatusMessage:

Public Types

typedef IGTLinkUSStatusMessage Self
 
typedef igtl::MessageBase Superclass
 
typedef igtl::SmartPointer< SelfPointer
 
typedef igtl::SmartPointer< const SelfConstPointer
 

Public Member Functions

 igtlTypeMacro (IGTLinkUSStatusMessage, igtl::MessageBase)
 
 igtlNewMacro (IGTLinkUSStatusMessage)
 
void SetProbeType (ProbeDefinition::TYPE probeType)
 
int GetProbeType ()
 
void SetOrigin (double o[3])
 
void SetOrigin (double oi, double oj, double ok)
 
void GetOrigin (double o[3])
 
void GetOrigin (double &oi, double &oj, double &ok)
 
const double * GetOrigin () const
 
void SetDepthStart (double depthStart)
 
double GetDepthStart ()
 
void SetDepthEnd (double depthEnd)
 
double GetDepthEnd ()
 
void SetWidth (double width)
 
double GetWidth ()
 
void SetDataFormat (std::string dataFormat)
 
std::string GetDataFormat ()
 

Protected Member Functions

 IGTLinkUSStatusMessage ()
 
virtual ~IGTLinkUSStatusMessage ()
 
virtual int GetBodyPackSize ()
 
virtual int PackBody ()
 
virtual int UnpackContent ()
 

Protected Attributes

ProbeDefinition::TYPE mProbeType
 1 = linear, 2 = sector More...
 
double mDataOrigin [3]
 Origin of sector in image coordinates. More...
 
double mDepthStart
 Start of sector in mm from origin. More...
 
double mDepthEnd
 End of sector in mm from origin. More...
 
double mWidth
 Width of sector in mm for LINEAR, Width of sector in radians for SECTOR. More...
 
std::string mDataFormat
 Format of image. B-mode, Angio, Beamdata, etc. More...
 
unsigned char * m_StatusMessage
 

Detailed Description

IGTLink Message content:

Date
Apr 16, 2012
Author
Ole Vegard Solberg, SINTEF int Type: Probe Type = 1 = sector 2 = linear

double OriginX double OriginY : Origin of sector in image coordinates

double DepthStart: Start of sector in mm from origin double DepthEnd: End of sector in mm from origin double Width: Width of sector in mm for LINEAR, Width of sector in radians for SECTOR.

String DataFormat: Format of image. B-mode, Angio, Beamdata, etc.

Definition at line 43 of file cxIGTLinkUSStatusMessage.h.

Member Typedef Documentation

◆ ConstPointer

typedef igtl::SmartPointer<const Self> cx::IGTLinkUSStatusMessage::ConstPointer

Definition at line 49 of file cxIGTLinkUSStatusMessage.h.

◆ Pointer

typedef igtl::SmartPointer<Self> cx::IGTLinkUSStatusMessage::Pointer

Definition at line 48 of file cxIGTLinkUSStatusMessage.h.

◆ Self

◆ Superclass

typedef igtl::MessageBase cx::IGTLinkUSStatusMessage::Superclass

Definition at line 47 of file cxIGTLinkUSStatusMessage.h.

Constructor & Destructor Documentation

◆ IGTLinkUSStatusMessage()

cx::IGTLinkUSStatusMessage::IGTLinkUSStatusMessage ( )
protected

Definition at line 20 of file cxIGTLinkUSStatusMessage.cpp.

◆ ~IGTLinkUSStatusMessage()

cx::IGTLinkUSStatusMessage::~IGTLinkUSStatusMessage ( )
protectedvirtual

Definition at line 36 of file cxIGTLinkUSStatusMessage.cpp.

Member Function Documentation

◆ GetBodyPackSize()

int cx::IGTLinkUSStatusMessage::GetBodyPackSize ( )
protectedvirtual

Definition at line 142 of file cxIGTLinkUSStatusMessage.cpp.

◆ GetDataFormat()

std::string cx::IGTLinkUSStatusMessage::GetDataFormat ( )

Definition at line 107 of file cxIGTLinkUSStatusMessage.cpp.

◆ GetDepthEnd()

double cx::IGTLinkUSStatusMessage::GetDepthEnd ( )

Definition at line 91 of file cxIGTLinkUSStatusMessage.cpp.

◆ GetDepthStart()

double cx::IGTLinkUSStatusMessage::GetDepthStart ( )

Definition at line 83 of file cxIGTLinkUSStatusMessage.cpp.

◆ GetOrigin() [1/3]

const double * cx::IGTLinkUSStatusMessage::GetOrigin ( ) const

Definition at line 67 of file cxIGTLinkUSStatusMessage.cpp.

◆ GetOrigin() [2/3]

void cx::IGTLinkUSStatusMessage::GetOrigin ( double &  oi,
double &  oj,
double &  ok 
)

Definition at line 72 of file cxIGTLinkUSStatusMessage.cpp.

◆ GetOrigin() [3/3]

void cx::IGTLinkUSStatusMessage::GetOrigin ( double  o[3])

Definition at line 60 of file cxIGTLinkUSStatusMessage.cpp.

◆ GetProbeType()

int cx::IGTLinkUSStatusMessage::GetProbeType ( )

Definition at line 43 of file cxIGTLinkUSStatusMessage.cpp.

◆ GetWidth()

double cx::IGTLinkUSStatusMessage::GetWidth ( )

Definition at line 99 of file cxIGTLinkUSStatusMessage.cpp.

◆ igtlNewMacro()

cx::IGTLinkUSStatusMessage::igtlNewMacro ( IGTLinkUSStatusMessage  )

◆ igtlTypeMacro()

cx::IGTLinkUSStatusMessage::igtlTypeMacro ( IGTLinkUSStatusMessage  ,
igtl::MessageBase   
)

◆ PackBody()

int cx::IGTLinkUSStatusMessage::PackBody ( )
protectedvirtual

Definition at line 112 of file cxIGTLinkUSStatusMessage.cpp.

◆ SetDataFormat()

void cx::IGTLinkUSStatusMessage::SetDataFormat ( std::string  dataFormat)

Definition at line 103 of file cxIGTLinkUSStatusMessage.cpp.

◆ SetDepthEnd()

void cx::IGTLinkUSStatusMessage::SetDepthEnd ( double  depthEnd)

Definition at line 87 of file cxIGTLinkUSStatusMessage.cpp.

◆ SetDepthStart()

void cx::IGTLinkUSStatusMessage::SetDepthStart ( double  depthStart)

Definition at line 79 of file cxIGTLinkUSStatusMessage.cpp.

◆ SetOrigin() [1/2]

void cx::IGTLinkUSStatusMessage::SetOrigin ( double  o[3])

Definition at line 47 of file cxIGTLinkUSStatusMessage.cpp.

◆ SetOrigin() [2/2]

void cx::IGTLinkUSStatusMessage::SetOrigin ( double  oi,
double  oj,
double  ok 
)

Definition at line 53 of file cxIGTLinkUSStatusMessage.cpp.

◆ SetProbeType()

void cx::IGTLinkUSStatusMessage::SetProbeType ( ProbeDefinition::TYPE  probeType)

Definition at line 39 of file cxIGTLinkUSStatusMessage.cpp.

◆ SetWidth()

void cx::IGTLinkUSStatusMessage::SetWidth ( double  width)

Definition at line 95 of file cxIGTLinkUSStatusMessage.cpp.

◆ UnpackContent()

int cx::IGTLinkUSStatusMessage::UnpackContent ( )
protectedvirtual

Definition at line 147 of file cxIGTLinkUSStatusMessage.cpp.

Member Data Documentation

◆ m_StatusMessage

unsigned char* cx::IGTLinkUSStatusMessage::m_StatusMessage
protected

Definition at line 85 of file cxIGTLinkUSStatusMessage.h.

◆ mDataFormat

std::string cx::IGTLinkUSStatusMessage::mDataFormat
protected

Format of image. B-mode, Angio, Beamdata, etc.

Definition at line 83 of file cxIGTLinkUSStatusMessage.h.

◆ mDataOrigin

double cx::IGTLinkUSStatusMessage::mDataOrigin[3]
protected

Origin of sector in image coordinates.

Definition at line 79 of file cxIGTLinkUSStatusMessage.h.

◆ mDepthEnd

double cx::IGTLinkUSStatusMessage::mDepthEnd
protected

End of sector in mm from origin.

Definition at line 81 of file cxIGTLinkUSStatusMessage.h.

◆ mDepthStart

double cx::IGTLinkUSStatusMessage::mDepthStart
protected

Start of sector in mm from origin.

Definition at line 80 of file cxIGTLinkUSStatusMessage.h.

◆ mProbeType

ProbeDefinition::TYPE cx::IGTLinkUSStatusMessage::mProbeType
protected

1 = linear, 2 = sector

Definition at line 78 of file cxIGTLinkUSStatusMessage.h.

◆ mWidth

double cx::IGTLinkUSStatusMessage::mWidth
protected

Width of sector in mm for LINEAR, Width of sector in radians for SECTOR.

Definition at line 82 of file cxIGTLinkUSStatusMessage.h.


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