Recent changes to PDU_Factory_Tutorial

PDU_Factory_Tutorial modified by Karl Jones

Karl Jones — Wed, 18 Nov 2015 10:05:57 -0000

--- v5
+++ v6
@@ -89,7 +89,7 @@

     if( pHeader->GetProtocolFamily() == Entity_Infomation_Interaction )
     {
-       cout <Entity_State_PDU*>( pHeader.get() );
+    Entity_State_PDU * pES = dynamic_cast<Entity_State_PDU*>( pHeader.get() );
     if( pES )
     {
        // Upcast was successful, now what?

PDU_Factory_Tutorial modified by Karl Jones

Karl Jones — Fri, 27 Jun 2014 12:06:11 -0000

--- v4
+++ v5
@@ -30,8 +30,15 @@
     PDU_Factory Factory;

-  
+### Add a filter

+    In version **1-15-0** and onwards it is possible to add a filter to the PDU factory. 
+    
+    // Lets apply a filter to the factory so it only lets through PDU that have an exercise ID of 1.
+    Factory.AddFilter( new FactoryFilterExerciseID( 1 ) );
+    
+
+     See [Creating_Custom_PDU_Factory_Filters] for further details on filters. 

 ## Decode a PDU

PDU_Factory_Tutorial modified by Karl Jones

Karl Jones — Fri, 27 Jun 2014 12:06:11 -0000

PDU_Factory_Tutorial modified by Karl Jones

Karl Jones — Fri, 27 Jun 2014 12:06:10 -0000

--- v2
+++ v3
@@ -2,63 +2,83 @@

 ## Intro

-The **PDU_Factory** is based on the [Factory Design Pattern](http://en.wikipedia.org/wiki/Factory_design_pattern)
+    The **PDU_Factory** is based on the [Factory Design Pattern](http://en.wikipedia.org/wiki/Factory_design_pattern)

-The **PDU_Factory** converts any DIS network packet into its correct PDU format and returns this PDU as a safe pointer to the PDU base class(_Header_). 
+    The **PDU_Factory** converts any DIS network packet into its correct PDU format and returns this PDU as a safe pointer to the PDU base class(_Header_). 

-**Note:** An example of using the **PDU_Factory** can also be found in the examples folder that comes with the KDIS distribution. 
+    **Note:** An example of using the **PDU_Factory** can also be found in the examples folder that comes with the KDIS distribution. 
+
+  
+

 ## Includes

-We first need to include the relevant header file/s. 
+    We first need to include the relevant header file/s. 

-We need to include the PDU_Factory.h which can be found in the _KDIS/Extras_ folder. 
+    We need to include the PDU_Factory.h which can be found in the _KDIS/Extras_ folder. 

     #include "KDIS/Extras/PDU_Factory.h"

+  
+
+
 ## Create the PDU_Factory

-We first need to create a **PDU_Factory** object. 
+    We first need to create a **PDU_Factory** object. 

     PDU_Factory Factory;

+  
+
+
 ## Decode a PDU

-We are now ready to start decoding DIS data. 
+    We are now ready to start decoding DIS data. 

-**Note:** I do not cover the use of sockets in this tutorial but the PDU_Factory example does come with some simple sockets that will work in Windows only. 
+    **Note:** I do not cover the use of sockets in this tutorial but the PDU_Factory example does come with some simple sockets that will work in Windows only. 

-The DIS network data should have been received in a char array format. in this example a KOCTET represents a char datatype. 
+    The DIS network data should have been received in a char array format. in this example a KOCTET represents a char datatype. 

     KOCTET cBuffer[MAX_PDU_SIZE]; // This is our buffer

-**Note:** MAX_PDU_SIZE is defined in KDefines.h, it is the maximun size a PDU can be in DIS. It should be safe to use this value for your buffer/s. 
+    **Note:** MAX_PDU_SIZE is defined in KDefines.h, it is the maximun size a PDU can be in DIS. It should be safe to use this value for your buffer/s. 

-Once some DIS data has been received into the buffer we can use the **PDU_Factory** to decode it. 
+    Once some DIS data has been received into the buffer we can use the **PDU_Factory** to decode it. 

     auto_ptr<Header> pHeader = Factory.Decode( cBuffer, ui32Recv ); // ui32Recv should be the size of the data packet received.

+  
+
+
 ## What do i do with the auto_ptr

-We now have a auto_ptr to the base class of our PDU. The auto_ptr is a safe pointer belonging to the STL. 
+    We now have a auto_ptr to the base class of our PDU. The auto_ptr is a safe pointer belonging to the STL. 

-When the auto_ptr object goes out of scope it will delete the pointer contained within thus preventing memory leaks. 
+    When the auto_ptr object goes out of scope it will delete the pointer contained within thus preventing memory leaks. 

-We now have 2 options. 
+    We now have 2 options. 
+
+  
+

 ### Do nothing

-We could just let the object expire if we are not interested in it, we do not need to do anything, the auto_ptr will clean up memory when it goes out of scope. 
+    We could just let the object expire if we are not interested in it, we do not need to do anything, the auto_ptr will clean up memory when it goes out of scope. 
+
+  
+

 ### Check For a Certain Type Of PDU

 #### Example 1

-E.G if we only wanted PDU that belonged to the _Entity Info Interaction_ protocol family we could do the following: 
+    
+
+  * E.G if we only wanted PDU that belonged to the _Entity Info Interaction_ protocol family we could do the following: 

     if( pHeader->GetProtocolFamily() == Entity_Infomation_Interaction )
     {
@@ -69,18 +89,20 @@
     }

-This method is fine providing we don’t mind the PDU being deleted once we go out of scope, but what is we wanted to keep the PDU? 
+    This method is fine providing we don’t mind the PDU being deleted once we go out of scope, but what is we wanted to keep the PDU? 

 #### Take Ownership

-We can prevent the auto_ptr from deleting the PDU pointer when it goes out of scope by taking ownership of the pointer. 
+    We can prevent the auto_ptr from deleting the PDU pointer when it goes out of scope by taking ownership of the pointer. 

-We do this using the _release_ function. 
+    We do this using the _release_ function. 

-E.G if we wanted the contents of a Entity_State_PDU: 
+    
+
+  * E.G if we wanted the contents of a Entity_State_PDU: 

     Entity_State_PDU * pES = dynamic_cast<Entity_State_PDU*>( pHeader.release() );
     if( pES )

PDU_Factory_Tutorial modified by Karl Jones

Karl Jones — Fri, 27 Jun 2014 12:06:10 -0000

--- v1
+++ v2
@@ -24,9 +24,11 @@
     PDU_Factory Factory;

-## Decode A PDU
+## Decode a PDU

-We are now ready to start decoding DIS data. **Note:** I do not cover the use of sockets in this tutorial but the PDU_Factory example does come with some simple sockets that will work in Windows only. 
+We are now ready to start decoding DIS data. 
+
+**Note:** I do not cover the use of sockets in this tutorial but the PDU_Factory example does come with some simple sockets that will work in Windows only. 

 The DIS network data should have been received in a char array format. in this example a KOCTET represents a char datatype. 

@@ -40,9 +42,11 @@
     auto_ptr<Header> pHeader = Factory.Decode( cBuffer, ui32Recv ); // ui32Recv should be the size of the data packet received.

-## Upcast The Pointer
+## What do i do with the auto_ptr

-We now have a auto_ptr to the base class of our PDU. The auto_ptr is a safe pointer belonging to the STL. When the auto_ptr object goes out of scope it will delete the pointer contained within thus preventing memory leaks. 
+We now have a auto_ptr to the base class of our PDU. The auto_ptr is a safe pointer belonging to the STL. 
+
+When the auto_ptr object goes out of scope it will delete the pointer contained within thus preventing memory leaks. 

 We now have 2 options. 

@@ -59,8 +63,6 @@
     if( pHeader->GetProtocolFamily() == Entity_Infomation_Interaction )
     {
        cout <Entity_State_PDU*>( pHeader.get() );
-    
-    
     if( pES )
     {
        // Upcast was successful, now what?
@@ -72,15 +74,15 @@

-##### Take Ownership
+#### Take Ownership

-We can prevent the auto_ptr from deleting the PDU pointer when it goes out of scope by taking ownership of the pointer. We do this using the _release_ function. 
+We can prevent the auto_ptr from deleting the PDU pointer when it goes out of scope by taking ownership of the pointer. 
+
+We do this using the _release_ function. 

 E.G if we wanted the contents of a Entity_State_PDU: 

     Entity_State_PDU * pES = dynamic_cast<Entity_State_PDU*>( pHeader.release() );
-    
-    
     if( pES )
     {
        // Upcast was successful and we now have complete ownership of it. Don’t forget to delete it when you are finished. delete pES;

PDU_Factory_Tutorial modified by Karl Jones

Karl Jones — Fri, 27 Jun 2014 12:06:10 -0000

Intro
Includes
Create the PDU_Factory
Decode A PDU
Upcast The Pointer
- Do nothing
- Check For a Certain Type Of PDU
  - Example 1
    - Take Ownership

Intro

The PDU_Factory is based on the Factory Design Pattern

The PDU_Factory converts any DIS network packet into its correct PDU format and returns this PDU as a safe pointer to the PDU base class(Header).

Note: An example of using the PDU_Factory can also be found in the examples folder that comes with the KDIS distribution.

Includes

We first need to include the relevant header file/s.

We need to include the PDU_Factory.h which can be found in the KDIS/Extras folder.

#include "KDIS/Extras/PDU_Factory.h"

Create the PDU_Factory

We first need to create a PDU_Factory object.

PDU_Factory Factory;

Decode A PDU

We are now ready to start decoding DIS data. Note: I do not cover the use of sockets in this tutorial but the PDU_Factory example does come with some simple sockets that will work in Windows only.

The DIS network data should have been received in a char array format. in this example a KOCTET represents a char datatype.

KOCTET cBuffer[MAX_PDU_SIZE]; // This is our buffer

Note: MAX_PDU_SIZE is defined in KDefines.h, it is the maximun size a PDU can be in DIS. It should be safe to use this value for your buffer/s.

Once some DIS data has been received into the buffer we can use the PDU_Factory to decode it.

auto_ptr&lt;Header&gt; pHeader = Factory.Decode( cBuffer, ui32Recv ); // ui32Recv should be the size of the data packet received.

Upcast The Pointer

We now have a auto_ptr to the base class of our PDU. The auto_ptr is a safe pointer belonging to the STL. When the auto_ptr object goes out of scope it will delete the pointer contained within thus preventing memory leaks.

We now have 2 options.

Do nothing

We could just let the object expire if we are not interested in it, we do not need to do anything, the auto_ptr will clean up memory when it goes out of scope.

Check For a Certain Type Of PDU

Example 1

E.G if we only wanted PDU that belonged to the Entity Info Interaction protocol family we could do the following:

if( pHeader-&gt;GetProtocolFamily() == Entity_Infomation_Interaction )
{
   cout &lt;Entity_State_PDU*&gt;( pHeader.get() );

if( pES )
{
   // Upcast was successful, now what?
}

This method is fine providing we don’t mind the PDU being deleted once we go out of scope, but what is we wanted to keep the PDU?

Take Ownership

We can prevent the auto_ptr from deleting the PDU pointer when it goes out of scope by taking ownership of the pointer. We do this using the release function.

E.G if we wanted the contents of a Entity_State_PDU:

Entity_State_PDU * pES = dynamic_cast&lt;Entity_State_PDU*&gt;( pHeader.release() );

if( pES )
{
   // Upcast was successful and we now have complete ownership of it. Don’t forget to delete it when you are finished. delete pES;
}