Changeset 157 for osgVisual/include/dataIO

Timestamp:

Nov 14, 2010, 5:13:41 PM (14 years ago)

Author:

Torben Dannhauer

Message:

 

File:

• osgVisual/include/dataIO/visual_dataIO.h (modified) (6 diffs)

osgVisual/include/dataIO/visual_dataIO.h

@@ -22 +22 @@
 #include <osgViewer/Viewer>
 
-// Cluster einbinden
+// Cluster
 #ifdef USE_CLUSTER_ASIO_TCP_IOSTREAM
         #include <dataIO_clusterAsioTcpIostream.h>
@@ -34 +34 @@
 
 
-//ExtLink einbinden
+//ExtLink 
 #ifdef USE_EXTLINK_DUMMY
         #include <dataIO_extLinkDummy.h>
@@ -43 +43 @@
 
 
-// slot and transportContainer definitions
+// Slot and transportContainer definitions
 #include <dataIO_slot.h>
 #include <dataIO_transportContainer.h>
 
+// XML Parser
+#include <stdio.h>
+#include <libxml/parser.h>
+#include <libxml/tree.h>
+
+// C++ stl libraries
 #include <vector>
 
@@ -108 +114 @@
         osg::ref_ptr<dataIO_finalDrawCallback> finalDrawCallback;
 
-        // Make Constructor private to prevent creating instances via ptr* = new ..().
+        /**
+         * \brief Constructor: It is private to prevent creating instances via ptr* = new ..().
+         * 
+         */ 
         visual_dataIO();
-        // Make Copy-Constructor private to prevent getting instances via copying dataIO instance.
+
+        /**
+         * \brief Copy-Constuctor: It is private to prevent getting instances via copying dataIO instance.
+         * 
+         * @param cc : Instance to copy from.
+         */ 
         visual_dataIO(const visual_dataIO& cc);
 
+        /**
+         * \brief This function parses the XML config file for dataIO relevant parameters.
+         * 
+         * @return : True if parsing was successful.
+         */ 
+        bool processXMLConfiguration(); 
+
+        /**
+         * \brief Todo: required?
+         * 
+         * @return 
+         */ 
         osg::Matrixd calcViewMatrix();
+
+        /**
+         * Pointer to the base class of the extLink implementation.
+         */ 
         osg::ref_ptr<dataIO_extLink> extLink;
+
+        /**
+         * Pointer to the base class of the cluster implementation.
+         */ 
         osg::ref_ptr<dataIO_cluster> cluster;
 
         /**
-         * Referenced Pointer to the applications viewer.
+         * Referenced pointer to the applications viewer.
          */ 
         osg::ref_ptr<osgViewer::Viewer> viewer;
 
+        /**
+         * Referenced pointer transport contained user to transport the set of all slots to all rendering machines.
+         */ 
         osg::ref_ptr<osgVisual::dataIO_transportContainer> slotContainer;
 
@@ -129 +166 @@
         std::vector<dataIO_slot*> dataSlots;
 
+        /**
+         * Flag to indicate if dataIO is initialized.
+         */ 
+        bool initialized;
+
+        /**
+         * The eventCallback-class is friend to be able to work with all dataIO members without setters/getters.
+         */ 
         friend class dataIO_eventCallback;
+
+        /**
+         *  The FinalDrawCallback-class is friend to be able to work with all dataIO members without setters/getters.
+         */ 
         friend class dataIO_finalDrawCallback;
 
 public:
-        // Public destructor to allow singleton cleanup from extern
+        /**
+         * \brief Public destructor to allow singleton cleanup from extern
+         * 
+         */ 
         ~visual_dataIO();
 
@@ -161 +213 @@
 
         osgVisual::dataIO_cluster::clustermode clusterMode;
-
-        bool initialized;
 };