documented DualEC_Sup

2 files changed, 86 insertions, 47 deletions

diff --git a/TAO/ChangeLog-99c b/TAO/ChangeLog-99c
index e181d018aaf..724720b833b 100644
--- a/TAO/ChangeLog-99c
+++ b/TAO/ChangeLog-99c
@@ -1,3 +1,7 @@
+Fri Feb 05 16:55:00 1999 Chris Gill <cdgill@cs.wustl.edu>
+
+        * TAO/orbsvcs/tests/Simulator/README: Documented DualEC_Sup.
+
 Fri Feb 05 16:05:00 1999 Chris Gill <cdgill@cs.wustl.edu>
 
         * TAO/orbsvcs/tests/Simulator/DOVEBrowser/PushConsumerFactory.java:
diff --git a/TAO/examples/Simulator/README b/TAO/examples/Simulator/README
index 78a8600f21c..0b4dd6d3db3 100644
--- a/TAO/examples/Simulator/README
+++ b/TAO/examples/Simulator/README
@@ -2,14 +2,15 @@ $Id$
 
 Documentation for the Simulator/DOVE demo
 
-Purpose: To show how the event service can be used to as a medium to
-         transport monitoring events including data. Also to
-         show how objects implemented in Java can access/can be accessed
-         by TAO objects.
-         Another purpose is also to show the feasability of
-         the DOVE framework as mentioned in
-         http://www.cs.wustl.edu/~schmidt/dove.html and
-         http://www.cs.wustl.edu/~schmidt/DOVE_and_LifeCycleService.ps.gz
+Purposes: 1) To show how the event service can be used to as a medium to
+          transport monitoring events including data. 
+          2) To show how objects implemented in Java can access/can be accessed
+          by TAO objects.
+          3) To show the feasability of the DOVE framework as mentioned in
+          http://www.cs.wustl.edu/~schmidt/dove.html and
+          http://www.cs.wustl.edu/~schmidt/DOVE_and_LifeCycleService.ps.gz
+          4) To serve as a visual demonstration tool for scheduling and event
+          service configurations and applications.
 
 Application: Using the Event Service as distribution media, event
              consumers and event suppliers are needed. The central
@@ -18,7 +19,8 @@ Application: Using the Event Service as distribution media, event
              consumers. Filtering can be activated.
              The mapping to DOVE is the following:
              Event Channel -    DOVE Agent
-             Event Consumer -   DOVE Browser and/or DOVE MIB
+             DOVE Browser 
+             and/or DOVE MIB -  Monitor/Event Consumer
              Event Supplier -   Monitored Application (here
                                 an object supplying recorded scheduling
                                 and dummy information)
@@ -27,18 +29,22 @@ Application: Using the Event Service as distribution media, event
                                 actual EC arrival and dispatching times in
                                 the scheduling information data structure
                                 viewed by the browser)
-
+             Dual EC Supplier - Monitored Application (here an object supplying
+                                separate Navigation and Weapons data sets
+                                in separate generating threads, which use
+                                separate push
+                                viewed by the browser)
 
 Implementation:
              The events contain structs with avionics information.
-             They are supllied by sensors of an avionic and are
-             consumed by the DOVE Browser, an JAVA applet running on
-             a different machine and/or location. The collected metrics are displayed in
-             JAVA Beans. A object called DOVE Management Information
-             Base connects to the same Event Channel. The MIB analyses the
-             the data field in the event. The field is a CORBA::Any,
-             so no assumptions can be made about the kind of data in
-             the event. The analysed Any is then printed into a file.
+             They are generated by the monitored application and are
+             consumed by the DOVE Browser, a JAVA applet or application running
+             on a different machine and/or location. The collected metrics are
+             displayed in the Browser. 
+
+             When an event arrives from the event supplier, a consumer inspects
+             the data field in the event. The field is a CORBA::Any, so
+             no assumptions can be made about the kind of data in the event.
 
              A C++ Supplier pushes events containing a
              navigation or weapons struct to the Event Service.
@@ -59,11 +65,8 @@ Requirements:
            * ACE/TAO environment,
            * Visibroker 3.2+ for Java
 
-
 !!RELEASE CHANGES:
-        - the file make.bat is in this directory just for test purposes.
-          It is used to switch from the Visibroker environment to the JDK 1.2
-          envrionment. So don't worry about it, you won't need it.
+        - the file make.bat has been expanded for use on NT
 
         - the file ss has been moved one level up and it got
           renamed to "start_services". So use it to start the
@@ -76,8 +79,9 @@ Requirements:
             make clean - removes all class files and idl generated java files
             make realclean - updates idl files, does a make clean
             make vb - makes the browser, using visibroker for java
+            make vbjava - remakes only the java files using vbjc
             make jdk - makes the browser, using jdk 
-                       (the does not currently work with jdk)
+                       (the demo does not currently work with jdk)
 
 Parts of the Demo:
 
@@ -91,6 +95,10 @@ Parts of the Demo:
           providing canned simulation data, allows the actual EC arrival and
           dispatching information to be recorded in the scheduling data
 
+        * Dual EC Supplier, can be seen as a monitored object, called
+          DOVE Application (implemented in C++ using TAO) - provides a paired
+          event and scheduling services for control over event prioritization.
+
         * DOVE MIB, storing event data on persistent storage and keeping
           track of statistical data (implemented in C++ using TAO)
 
@@ -99,28 +107,44 @@ Files:
         NavWeap.idl - IDL definition of the Weapons and Navigation structures
         README - this readme file
 
-        Event Supplier: (in directory  $TAO_ROOT/orbsvcs/tests/Simulator/Event_Supplier/)
+        Event Supplier: 
+          (in directory  $TAO_ROOT/orbsvcs/tests/Simulator/Event_Supplier/)
+        DualEC_Sup.cpp - Dual EC Event Supplier
+        DualEC_Sup.h   - Dual EC Event Supplier class definitions
         Event_Sup.cpp - Event Supplier
         Event_Sup.h   - Event Supplier class definition
         Logging_Sup.cpp - Event Supplier for EC logging
         Logging_Sup.h   - Event Supplier for EC logging class definition
         Makefile      - Event Supplier Makefile
-                (Event_Con.cpp, Event_Con.h - Event Consumer for testing)
-                svc.conf - helper file
+        (Event_Con.cpp, Event_Con.h - Event Consumer for testing)
+        svc.conf - helper file
 
-
-        DOVEBrowswer: (in directory  $TAO_ROOT/orbsvcs/tests/Simulator/DOVEBrowser/)
+        DOVEBrowswer: 
+          (in directory  $TAO_ROOT/orbsvcs/tests/Simulator/DOVEBrowser/)
                 AnswerEvent.java  - Having my own Events
                 AnswerListener.java - Listener for these Events
                 DataHandler.java  - Base class for all Data Handlers
-                DemoCore.java - Core of the Demo to connect Observables with Observers
+                DemoCore.java - Core of the Demo to connect Observables 
+                                with Observers
                 DemoObservable.java - Base class for Observables
-                DoubleVisComp.java  - Visualization Component (will be a JavaBean) for Doubles
+                DoubleVisComp.java  - Visualization Component 
+                                      (will be a JavaBean) for Doubles
                 DOVEBrowser.java - Wrapper around DemoCore
-                NS_Resolve.java  - Resolving the inital reference to the Naming Service
-                NavWeapDataHandler.java  - Specialized Data Handler for Navigation and Weapon data
-                NavigationVisComp.java - Visualization Component (... JavaBean) for Navigation data
-                ObservablesDialog.java - Dialog window for connecting Observables with OBservers
+                DOVEBrowserApplet.java - Applet wrapper around DemoCore
+                MTQueue.java - synchronized queue for multi-threaded access
+                MTDataHandlerAdapter.java - uses the Adapter and Active Object 
+                                            patterns to provide early demuxing
+                                            of ORB upcalls onto multiple
+                                            synchronized queues managed by
+                                            data handler threads
+                NS_Resolve.java  - Resolving the inital reference 
+                                   to the Naming Service
+                NavWeapDataHandler.java  - Specialized Data Handler for 
+                                           Navigation and Weapons data
+                NavigationVisComp.java - Visualization Component 
+                                         (... JavaBean) for Navigation data
+                ObservablesDialog.java - Dialog window for connecting 
+                                         Observables with OBservers
                 Properties.java - constant definitons
                 PushConsumer.java - Event Service Push Consumer
                 PushConsumerFactory.java - Factory for the Consumer
@@ -129,14 +153,17 @@ Files:
                 WeaponsVisComp.java - Visualization Component for Weapons
 
 
-        DOVE MIB: (in directory  $TAO_ROOT/orbsvcs/tests/Simulator/DOVEMIB/)
-                DOVEMIB.[cpp,h] - Core routines, connection to the Event Channel
+        DOVE MIB: 
+          (in directory  $TAO_ROOT/orbsvcs/tests/Simulator/DOVEMIB/)
+                DOVEMIB.[cpp,h] - Core routines, connection to the 
+                                  Event Channel
                 Node.[cpp,h] - Nodes used by the AnyAnalyser
-                AnyAnalyser.[cpp,h] - Anaylser for CORBA anys, storing the contained types on
-                                                persistent storage
+                AnyAnalyser.[cpp,h] - Anaylser for CORBA anys, storing the 
+                                      contained types in persistent storage
                 NodeVisitor.h - base class definition of a Visitor
-                PrintVisistor.[cpp,h] - Able to print a given tree of type nodes, which is
-                                                generated by the Anyanalyser
+                PrintVisistor.[cpp,h] - Able to print a given tree 
+                                        of type nodes, which is
+                                        generated by the Any analyser
 
 
 Compiling:
@@ -164,14 +191,15 @@ Compiling:
 
         NT:
                 Open the Event_Sup.dsw workspace found in the
-                Event_Supplier directory in MSVC++ 5.0+
-                and build the Event_Sup and Logging_Sup projects.
+                Event_Supplier directory in MSVC++ 5.0+ and build 
+                the Event_Sup, Logging_Sup, and DualEC_Sup projects.
 
                 From a console window, change to the DOVEBrowser 
                 directory and run "make vb" to build the browser using 
-                Visibroker (you may first want to do a "make realclean" 
-                each time you rebuild in case there were changes to IDL 
-                files).
+                Visibroker.  The first time you do this, you will need to
+                run "make setup" to copy the correct files into the directory.
+                You may also want to do a "make realclean" each time you
+                rebuild in case there were changes to IDL files.
 
 Starting:
 
@@ -196,10 +224,17 @@ Starting:
                 // -f MLF.dat to read operation names from this file as input
 
 
+        Dual EC Supplier (live latency and jitter data over two channels):
+                DualEC_Sup -ORBport 10040 -f MLF.dat -m 1000
+
+                // -m 1000 for 1000 events sent by the supplier
+                // -f MLF.dat to read operation names from this file as input
+
         DOVE Browser:
                 vbj DOVEBrowser
                 (also supported: vbj DOVEBrowser -ORBnameserviceior <IOR> 
-                                 vbj DOVEBrowser -ORBnameserviceport <port>)
+                                 vbj DOVEBrowser -ORBnameserviceport <port>
+                                 vbj DOVEBrowser -dualECdemo)
 
                 or
 
@@ -216,5 +251,5 @@ Starting:
                 DOVEMIB -ORBport 10041 -f myfile -m 100
 
                 // -m 100 for storing the next 100 events
-                // -f myfile for the name of the file in which it will be stored
+                // -f <name of the file in which it will be stored>