OpenIGTLink/Library/Tutorial - Revision history

Goerlitz: /* Setting up the library */

2008-12-16T20:35:40Z

Setting up the library

2008-12-16T16:08:53Z

Code snippet from Tracker Client program

2008-12-16T16:08:33Z

Get the example code

2008-10-02T15:23:45Z

Code snippet from Receiver Server program

2008-07-15T22:15:21Z

Code snippet from Receiver Server program

2008-07-15T22:14:53Z

Code snippet from Receiver Server program

2008-07-15T22:14:21Z

Code snippet from Tracker Client program

2008-07-15T22:13:01Z

Code snippet from Receiver Server program

2008-07-15T22:12:40Z

Code snippet from Receiver Server program

2008-07-15T21:49:58Z

Code snippet from Receiver Server program

@@ Line 16: / Line 16: @@
 =Setting up the library=
-Please refer [[OpenIGTLink/Library/Build | the Open IGT Link library building instruction]].
+Please refer to[[OpenIGTLink/Library/Build | the Open IGT Link library building instruction]].
 <BR>

@@ Line 79: / Line 79: @@
    transMsg = igtl::TransformMessage::New();
-Set Open IGT Link device name:
+Set the Open IGT Link device name:
    transMsg->SetDeviceName("Tracker");

@@ Line 29: / Line 29: @@
 ==Get the example code==
-The example code is available in the Examples/ directory of Open IGT Link library. The instruction is available in [[OpenIGTLink/Library | the Open IGT Link Library page]].
+The example code is available in the Examples/ directory of Open IGT Link library. The instruction is available on [[OpenIGTLink/Library | the Open IGT Link Library page]].
 {|border="1" cellpadding="2"
@@ Line 56: / Line 56: @@
 ||Example to send image data; works as a TCP client
 |}
 ==Code snippet from Tracker Client program==

@@ Line 139: / Line 139: @@
          headerMsg->Unpack();
-The message type can be access by headerMsg->GetDeviceType() funciton. When you write message handler for TRANSFORM type message, you may compare the type name like:
+The message type can be accessed by headerMsg->GetDeviceType() function. When you write message handler for TRANSFORM type message, you may compare the type name like:
          if (strcmp(headerMsg->GetDeviceType(), "TRANSFORM") == 0)

@@ Line 105: / Line 105: @@
 ==Code snippet from Receiver Server program==
-In contrast to the example above, "[http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink/Examples/Receiver/ReceiveServer.cxx Examlpes/Receiver/ReceiveServer.cxx] demonstrates how to wait for a connection from a client and receive Open IGT Link messages, using the Open IGT Link Library C++ interface.
+In contrast to the example above, "[http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink/Examples/Receiver/ReceiveServer.cxx Examlpes/Receiver/ReceiveServer.cxx] demonstrates how to wait for the connection from the client and receive Open IGT Link messages, using the Open IGT Link Library C++ interface.
 First, prepare server socket to wait for the client to connect. Suppose the port number is 18944.

@@ Line 60: / Line 60: @@
 ==Code snippet from Tracker Client program==
-The code "Tracker/TrackerClient.cxx" demonstrates how to create open igt link message, establish connection with the Open IGT Link server, then repeat sending coordinate data to the server, using Open IGT Link Library.
+The code "[http://svn.na-mic.org/NAMICSandBox/trunk/OpenIGTLink/Examples/Tracker/TrackerClient.cxx Tracker/TrackerClient.cxx]" demonstrates how to create open igt link message, establish connection with the Open IGT Link server, then repeat sending coordinate data to the server, using Open IGT Link Library.
 First, establish connection with server (ip: 192.168.0.1, port number: 18944) using igtl::ClientSocket class:
@@ Line 102: / Line 102: @@
 The igtl::ClientSocket class can be replaced by other socket library.
 ==Code snippet from Receiver Server program==

@@ Line 123: / Line 123: @@
        // start receiving data
-Now the connection has been established. To receive a message header, we create igtl::MessageHeader class instance.
+Now the connection has been established. To receive a message header, create igtl::MessageHeader class instance.
          igtl::MessageHeader::Pointer headerMsg;
@@ Line 132: / Line 132: @@
          headerMsg->InitPack();
-Then call Receive() function to get byte stream from the socket connection. The Receive() function returns the size of the received data. You can testify the result by comparing returned value with header size (can be obtained by using headerMsg->GetPackSize())
+Then call Receive() function to get byte stream from the socket connection. The Receive() function returns the size of the received data. You can check the result by comparing returned value with header size (can be obtained by using headerMsg->GetPackSize())
          int r = socket->Receive(headerMsg->GetPackPointer(), headerMsg->GetPackSize());

@@ Line 108: / Line 108: @@
 In contrast to the example above, Examlpes/Receiver/ReceiveServer.cxx demonstrates how to wait for a connection from a client and receive Open IGT Link messages, using the Open IGT Link Library C++ interface.
-First, prepare server socket to wait for a client to connect. Suppose the port number is 18944.
+First, prepare server socket to wait for the client to connect. Suppose the port number is 18944.
    igtl::ServerSocket::Pointer serverSocket;