#include <igtlBindMessage.h>


Public Types | |
| enum | { UNPACK_UNDEF = 0x0000 , UNPACK_HEADER = 0x0001 , UNPACK_BODY = 0x0002 } |
| typedef SmartPointer< const Self > | ConstPointer |
| typedef SmartPointer< Self > | Pointer |
| typedef StartBindMessage | Self |
| typedef GetBindMessage | Superclass |
Static Public Member Functions | |
| static void | BreakOnError () |
| static Pointer | New () |
Protected Member Functions | |
| virtual void | AllocateBuffer (int contentSize) |
| virtual void | AllocateUnpack (int bodySizeToRead) |
| virtual int | CalculateContentBufferSize () |
| int | CopyBody (const MessageBase *mb) |
| int | CopyHeader (const MessageBase *mb) |
| virtual int | PackContent () |
| StartBindMessage () | |
| void | UnpackBody (int crccheck, int &r) |
| virtual int | UnpackContent () |
| void | UnpackHeader (int &r) |
| ~StartBindMessage () | |
Protected Attributes | |
| unsigned char * | m_Body |
| int | m_BodySizeToRead |
| std::vector< ChildMessageInfo > | m_ChildMessages |
| unsigned char * | m_Content |
| std::string | m_DeviceName |
| unsigned char * | m_Header |
| unsigned short | m_HeaderVersion |
| bool | m_IsBodyPacked |
| bool | m_IsBodyUnpacked |
| bool | m_IsHeaderUnpacked |
| int | m_MessageSize |
| std::string | m_ReceiveMessageType |
| igtlUint64 | m_Resolution |
| std::string | m_SendMessageType |
| unsigned int | m_TimeStampSec |
| unsigned int | m_TimeStampSecFraction |
| volatile int | m_ReferenceCount |
| SimpleFastMutexLock | m_ReferenceCountLock |
| virtual void | PrintHeader (std::ostream &os) const |
| virtual void | PrintTrailer (std::ostream &os) const |
| virtual void | PrintSelf (std::ostream &os) const |
| static void | SetGlobalWarningDisplay (bool flag) |
| static bool | GetGlobalWarningDisplay () |
| static void | GlobalWarningDisplayOn () |
| static void | GlobalWarningDisplayOff () |
A class for the STT_BIND message type. Like the GET_BIND message type, it contains a list of child messages to request for specific messages. If no child message is specified, the receiver must return the all available messages.
Definition at line 155 of file igtlBindMessage.h.
Definition at line 161 of file igtlBindMessage.h.
Definition at line 160 of file igtlBindMessage.h.
Definition at line 158 of file igtlBindMessage.h.
Definition at line 159 of file igtlBindMessage.h.
Unpack status. They are returned by the Unpack() function.
| Enumerator | |
|---|---|
| UNPACK_UNDEF | |
| UNPACK_HEADER | |
| UNPACK_BODY | |
Definition at line 95 of file igtlMessageBase.h.
|
protected |
|
protected |
|
inherited |
AllocatePack() allocates memory for underlying buffer If m_BodySizeToRead > 0, we are allocating for receiving a message
Allocates memory specifying the content size. Implicitly allocates extended header, metadata header and metadata in addition to content
Reimplemented in igtl::ImageMessage2.
|
inlineinherited |
Definition at line 242 of file igtlMessageBase.h.
Allocates memory specifying the unpack content size Size of body to allocate is determined from v1 message header field 'body_size'
Appends the type and name of a new child message to the end of the list of child messages. The AppendChildMessage() function will increment the number of child messages. Returns the number of child messages.
|
inherited |
Appends a new child message to the end of the list of child messages. The AppendChildMessage() function will increment the number of child messages. Returns the number of child messages after appending the specified child message.
This method is called when igtlExceptionMacro executes. It allows the debugger to break on error.
Gets the size of the serialized content.
Reimplemented from igtl::GetBindMessage.
|
inherited |
Calculate the size of the received content data Returns -1 if the extended header has not been properly initialized (meta data size, meta data header size, etc...) Used when receiving data, not sending
|
virtualinherited |
Create a clone of this message, new memory but all internals are preserved.
|
inherited |
Copy() copies contents from the specified Massage class. If the type of the specified class is the same as this class, general header and body are copied.
|
protectedinherited |
Copies the serialized body data.
|
protectedinherited |
Copies a header from given message.
|
virtualinherited |
Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.
Reimplemented from igtl::LightObject.
Delete an igtl object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.
|
inherited |
GetBodySizeToRead() returns the size of the body to be read. This function must be called after the message header is set.
|
inherited |
Gets a pointer to the raw byte array for the serialized body data.
|
inherited |
Gets the size of the serialized body data.
|
inherited |
Gets a pointer to the raw byte array for the serialized data including the header and the body.
|
inherited |
Gets the size of the serialized message data.
Gets the name of a child message specified by the index 'i'.
|
inherited |
Get the value of the debug flag.
|
inherited |
Gets the device name.
Gets the message version number.
|
inherited |
Gets the message type.
Return the name of this class as a string. Used by the object factory (implemented in New()) to instantiate objects of a named type. Also used for debugging and other output information.
Definition at line 84 of file igtlLightObject.h.
|
inherited |
Gets the number of child messages bundled in the message.
|
inlineinherited |
Definition at line 218 of file igtlMessageBase.h.
|
inlineinherited |
Definition at line 226 of file igtlMessageBase.h.
|
inlineinherited |
Definition at line 214 of file igtlMessageBase.h.
|
inlineinherited |
Definition at line 222 of file igtlMessageBase.h.
Gets the reference count on this object.
Definition at line 110 of file igtlLightObject.h.
| igtlUint64 igtl::StartBindMessage::GetResolution | ( | ) |
Gets time resolution. The time resolution is specified as a 64-bit fixed-point used in OpenIGTLink time stamp.
|
inherited |
Gets time of message creation.
Gets time of message creation. 'sec' and 'frac' are seconds and fractions of a second respectively.
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Definition at line 116 of file igtlObject.h.
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Definition at line 114 of file igtlObject.h.
|
inherited |
|
inherited |
| igtl::StartBindMessage::igtlNewMacro | ( | igtl::StartBindMessage | ) |
|
inherited |
|
inherited |
| igtl::StartBindMessage::igtlTypeMacro | ( | igtl::StartBindMessage | , |
| igtl::GetBindMessage | |||
| ) |
|
inherited |
Standard part of all igtl objects.
|
inherited |
Initializes the BindMessageBase class.
|
inherited |
Call InitPack() before receive header. This function simply resets the Unpacked flag for both the header and body pack Only allocate the original 58 byte header
|
inlineinherited |
Definition at line 249 of file igtlMessageBase.h.
Method for creation through the object factory.
Pack() serializes the header and body based on the member variables. PackContent() must be implemented in the child class.
Reimplemented in igtl::ImageMessage2.
Packs (serialize) the content. Must be implemented in all child classes.
Reimplemented from igtl::GetBindMessage.
|
inherited |
Cause the object to print itself out.
Number of uses of this object by other objects.
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from igtl::LightObject.
Reimplemented in igtl::ClientSocket, igtl::FastMutexLock, igtl::MultiThreader, igtl::MutexLock, igtl::ObjectFactoryBase, igtl::ServerSocket, igtl::Socket, and igtl::TimeStamp.
Number of uses of this object by other objects.
Return this objects modified time.
Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.
Increase the reference count (mark as used by another object).
Reimplemented from igtl::LightObject.
|
inherited |
Sets or replaces a child message specified by the index 'i'. The SetChildMessage() does not increment the number of child messages. Returns non-zero value, if success.
Set the value of the debug flag. A non-zero value turns debugging on.
Sets the device (message) type.
This is a global flag that controls whether any debug, warning or error messages are displayed.
Sets the message version number.
|
virtualinherited |
Sets the message header.
Reimplemented in igtl::PositionMessage.
Sets the number of child messages bundled in the message and returns the total number of child messages. The returned value should be same as 'n', if the number is updated successfully.
Sets the reference count (use with care)
Reimplemented from igtl::LightObject.
| void igtl::StartBindMessage::SetResolution | ( | igtlUint64 | res | ) |
Sets time resolution. The time resolution is specified as a 64-bit fixed-point used in OpenIGTLink time stamp.
|
inherited |
Sets time of message creation.
Sets time of message creation. 'sec' and 'frac' are seconds and fractions of a second respectively.
Unpack() deserializes the header and/or body, extracting data from the byte stream. If the header has already been deserilized, Unpack() deserializes only the body part. UnpackBody() must be implemented to deserialize the body part. Unpack() performs 64-bit CRC check, when crccheck = 1. It returns:
UNPACK_UNDEF : Nothing deserialized UNPACK_HEADER : The header has been deserialized. UNPACK_BODY : The body has been deserialized. If CRC check fails, Unpack() doesn't deserialize the body, thus it doesn't return UNPACK_BODY flag. UNPACK_HEADER|UNPACK_BODY: Both the header and body have been deserialized
Unpack the body If it's a v3 message, body is ext header + content + metadataheader + metadata<optional>
Unpacks (deserialize) the content. Must be implemented in all child classes.
Reimplemented from igtl::GetBindMessage.
Decrease the reference count (release by another object).
Reimplemented from igtl::LightObject.
A pointer to the byte array for the serialized body. To prevent large copy of the byte array in the Pack() function, header byte array is concatenated to the byte array for the header.
Definition at line 308 of file igtlMessageBase.h.
|
protectedinherited |
The size of the body to be read. This function must be called after the message header is set.
Definition at line 315 of file igtlMessageBase.h.
|
protectedinherited |
A vector to manage a list of ChildMessageInfo structures.
Definition at line 83 of file igtlBindMessage.h.
A pointer to the underlying content of a message.
Definition at line 311 of file igtlMessageBase.h.
|
protectedinherited |
A character string for the device name (message name).
Definition at line 328 of file igtlMessageBase.h.
A pointer to the byte array for the serialized header. To prevent large copy of the byte array in the Pack() function, header byte array is concatenated to the byte array for the body.
Definition at line 303 of file igtlMessageBase.h.
An unsigned short for the message format version.
Definition at line 325 of file igtlMessageBase.h.
|
protectedinherited |
Packing (serialization) status for the body.
Definition at line 345 of file igtlMessageBase.h.
|
protectedinherited |
Unpacking (deserialization) status for the body.
Definition at line 342 of file igtlMessageBase.h.
|
protectedinherited |
Unpacking (deserialization) status for the header.
Definition at line 339 of file igtlMessageBase.h.
|
protectedinherited |
Definition at line 298 of file igtlMessageBase.h.
|
protectedinherited |
A character string for the device type (message type). This will be used when the header is deserialized from a byte stream received from the network.
Definition at line 322 of file igtlMessageBase.h.
Number of uses of this object by other objects.
Definition at line 131 of file igtlLightObject.h.
|
mutableprotectedinherited |
Mutex lock to protect modification to the reference count
Definition at line 134 of file igtlLightObject.h.
|
protected |
Definition at line 186 of file igtlBindMessage.h.
|
protectedinherited |
A character string for the send device type (message type).
Definition at line 318 of file igtlMessageBase.h.
A time stamp (second) for message creation. It consists of fields for seconds (m_TimeStampSec)and fractions of a second (m_TimeStampSecFraction).
Definition at line 332 of file igtlMessageBase.h.
A time stamp (second) for message creation. It consists of fields for seconds (m_TimeStampSec)and fractions of a second (m_TimeStampSecFraction).
Definition at line 336 of file igtlMessageBase.h.