[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[certi-cvs] certi doc/certi_user_doc.tree doc/certi_install...
|
From: |
certi-cvs |
|
Subject: |
[certi-cvs] certi doc/certi_user_doc.tree doc/certi_install... |
|
Date: |
Mon, 10 Nov 2008 13:19:01 +0000 |
CVSROOT: /sources/certi
Module name: certi
Changes by: Eric NOULARD <erk> 08/11/10 13:19:01
Modified files:
doc : certi_user_doc.tree certi_install.cnf.in
certi_user.cnf.in execute.dox
certi_developer.cnf.in certi_developer_doc.tree
RTIG : Federation.hh main.cc Federation.cc
RTIA : main.cc
Log message:
User documentation update
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user_doc.tree?cvsroot=certi&r1=3.4&r2=3.5
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_install.cnf.in?cvsroot=certi&r1=3.5&r2=3.6
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user.cnf.in?cvsroot=certi&r1=3.7&r2=3.8
http://cvs.savannah.gnu.org/viewcvs/certi/doc/execute.dox?cvsroot=certi&r1=3.3&r2=3.4
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_developer.cnf.in?cvsroot=certi&r1=3.3&r2=3.4
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_developer_doc.tree?cvsroot=certi&r1=3.2&r2=3.3
http://cvs.savannah.gnu.org/viewcvs/certi/RTIG/Federation.hh?cvsroot=certi&r1=3.53&r2=3.54
http://cvs.savannah.gnu.org/viewcvs/certi/RTIG/main.cc?cvsroot=certi&r1=3.20&r2=3.21
http://cvs.savannah.gnu.org/viewcvs/certi/RTIG/Federation.cc?cvsroot=certi&r1=3.100&r2=3.101
http://cvs.savannah.gnu.org/viewcvs/certi/RTIA/main.cc?cvsroot=certi&r1=3.23&r2=3.24
Patches:
Index: doc/certi_user_doc.tree
===================================================================
RCS file: /sources/certi/certi/doc/certi_user_doc.tree,v
retrieving revision 3.4
retrieving revision 3.5
diff -u -b -r3.4 -r3.5
--- doc/certi_user_doc.tree 19 Oct 2008 21:44:24 -0000 3.4
+++ doc/certi_user_doc.tree 10 Nov 2008 13:19:00 -0000 3.5
@@ -28,14 +28,14 @@
* \image html "certi.png"
* <h1>User Documentation</h1>
*
- * This is the CERTI installation documentation.
- * The installation documentation is divided into several part:
+ * This is the CERTI user documentation.
+ * The user documentation is divided into several part:
*
* <ul>
* <li>\ref intro</li>
- * <li>\ref user</li>
+ * <li>\ref execute</li>
* </ul>
*
*/
-// $Id: certi_user_doc.tree,v 3.4 2008/10/19 21:44:24 gotthardp Exp $
+// $Id: certi_user_doc.tree,v 3.5 2008/11/10 13:19:00 erk Exp $
Index: doc/certi_install.cnf.in
===================================================================
RCS file: /sources/certi/certi/doc/certi_install.cnf.in,v
retrieving revision 3.5
retrieving revision 3.6
diff -u -b -r3.5 -r3.6
--- doc/certi_install.cnf.in 26 Oct 2008 16:20:12 -0000 3.5
+++ doc/certi_install.cnf.in 10 Nov 2008 13:19:00 -0000 3.6
@@ -17,7 +17,7 @@
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
-PROJECT_NAME = "CERTI Installation"
+PROJECT_NAME = "CERTI Install Documentation"
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
Index: doc/certi_user.cnf.in
===================================================================
RCS file: /sources/certi/certi/doc/certi_user.cnf.in,v
retrieving revision 3.7
retrieving revision 3.8
diff -u -b -r3.7 -r3.8
--- doc/certi_user.cnf.in 27 Oct 2008 10:25:56 -0000 3.7
+++ doc/certi_user.cnf.in 10 Nov 2008 13:19:00 -0000 3.8
@@ -17,7 +17,7 @@
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
-PROJECT_NAME = CERTI_User
+PROJECT_NAME = CERTI User Documentation
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
@@ -437,7 +437,9 @@
INPUT = "${CMAKE_SOURCE_DIR}/doc/certi_user_doc.tree" \
"${CMAKE_SOURCE_DIR}/doc/introduction.dox" \
"${CMAKE_SOURCE_DIR}/doc/execute.dox" \
+ "${CMAKE_SOURCE_DIR}/libCERTI/SocketHTTPProxy.cc" \
"${CMAKE_SOURCE_DIR}/RTIG/main.cc" \
+ "${CMAKE_SOURCE_DIR}/RTIG/Federation.cc" \
"${CMAKE_SOURCE_DIR}/RTIA/main.cc"
# If the value of the INPUT tag contains directories, you can use the
Index: doc/execute.dox
===================================================================
RCS file: /sources/certi/certi/doc/execute.dox,v
retrieving revision 3.3
retrieving revision 3.4
diff -u -b -r3.3 -r3.4
--- doc/execute.dox 27 Oct 2008 10:26:50 -0000 3.3
+++ doc/execute.dox 10 Nov 2008 13:19:00 -0000 3.4
@@ -25,9 +25,16 @@
* }
* \enddot
*
- * TODO: How to execute simulation: (0) configure PATH, (1) store .fed file,
(2) run rtig,
- * (3) configure HOST/PORT/PROXY, (3) run federations, rtia is started
automatically.
- *
+ * \subsection certi_user_execute
+ * If ones want to properly execute an HLA simulation using CERTI one must:
+ * (FIXME more detail to come).
+ * <ol>
+ * <li> configure PATH </li>
+ * <li> store .fed (or .xml) FOM file in the search path of the rtig \see
certi_FOM_FileSearch</li>
+ * <li> run rtig, \see certi_executable_RTIG </li>
+ * <li> configure HOST/PORT/PROXY, </li>
+ * <li> run federations, rtia is started automatically. </li>
+ * </ol>
* \subsection certi_user_env CERTI environment variables
*
* CERTI uses a set of environment variables which may influence its
@@ -38,7 +45,16 @@
* <td><b>Variable</b></td><td><b>Used by</b></td><td><b>Description</b></td>
* </tr>
* <tr>
- * <td>CERTI_HOST</td> <td>RTIA</td><td>machine on which RTIG is running</td>
+ * <td>CERTI_HOME</td> <td>RTIG</td><td>the CERTI installation base directory.
+ * This is used by the RTIG in order
+ * to look for FOM files
+ * (see \ref certi_executable_RTIG).</td>
+ * </tr>
+ * <tr>
+ * <td>CERTI_HOST</td> <td>RTIA</td><td>machine on which RTIG is running.
+ * As soon as it starts the RTIA will try
to connect
+ * to the RTIG running on CERTI_HOST
+ * (see \ref certi_executable_RTIA).</td>
* </tr>
* <tr>
* <td>CERTI_TCP_PORT</td> <td>RTIG, RTIA</td> <td>TCP port used for RTIA/RTIG
communications</td>
@@ -77,4 +93,4 @@
* \image latex "billiard.png" "Billard consoleshot" width=12cm
*/
-// $Id: execute.dox,v 3.3 2008/10/27 10:26:50 erk Exp $
+// $Id: execute.dox,v 3.4 2008/11/10 13:19:00 erk Exp $
Index: doc/certi_developer.cnf.in
===================================================================
RCS file: /sources/certi/certi/doc/certi_developer.cnf.in,v
retrieving revision 3.3
retrieving revision 3.4
diff -u -b -r3.3 -r3.4
--- doc/certi_developer.cnf.in 13 Oct 2008 14:32:36 -0000 3.3
+++ doc/certi_developer.cnf.in 10 Nov 2008 13:19:00 -0000 3.4
@@ -17,7 +17,7 @@
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
-PROJECT_NAME = CERTI_Developer
+PROJECT_NAME = CERTI Developer Documentation
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
Index: doc/certi_developer_doc.tree
===================================================================
RCS file: /sources/certi/certi/doc/certi_developer_doc.tree,v
retrieving revision 3.2
retrieving revision 3.3
diff -u -b -r3.2 -r3.3
--- doc/certi_developer_doc.tree 13 Oct 2008 14:32:35 -0000 3.2
+++ doc/certi_developer_doc.tree 10 Nov 2008 13:19:01 -0000 3.3
@@ -31,7 +31,7 @@
* <ul>
* <li>\ref intro </li>
* <li>\ref install </li>
- * <li>\ref user </li>
+ * <li>\ref execute </li>
* <li>\ref certi_modules </li>
* </ul>
*
Index: RTIG/Federation.hh
===================================================================
RCS file: /sources/certi/certi/RTIG/Federation.hh,v
retrieving revision 3.53
retrieving revision 3.54
diff -u -b -r3.53 -r3.54
--- RTIG/Federation.hh 9 Nov 2008 12:41:39 -0000 3.53
+++ RTIG/Federation.hh 10 Nov 2008 13:19:01 -0000 3.54
@@ -18,7 +18,7 @@
// along with this program ; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
-// $Id: Federation.hh,v 3.53 2008/11/09 12:41:39 gotthardp Exp $
+// $Id: Federation.hh,v 3.54 2008/11/10 13:19:01 erk Exp $
// ----------------------------------------------------------------------------
#ifndef _CERTI_RTIG_FEDERATION_HH
@@ -82,6 +82,16 @@
// METHODS
-----------------------------------------------------------------
public:
#ifdef FEDERATION_USES_MULTICAST
+ /**
+ * Allocates memory the Name's storage, and read its FED file to store
the
+ * result in RootObj.
+ * (with FEDERATION_USES_MULTICAST defined).
+ * @param federation_name
+ * @param federation_handle
+ * @param socket_server
+ * @param audit_server
+ * @param mc_link
+ */
Federation(const char *,
FederationHandle,
SocketServer &,
@@ -89,6 +99,16 @@
SocketMC*,
int theVerboseLevel)
#else
+ /**
+ * Allocates memory the Name's storage, and read its FED file
to store the
+ * result in RootObj.
+ * with FEDERATION_USES_MULTICAST not defined
+ * @param federation_name
+ * @param federation_handle
+ * @param socket_server
+ * @param audit_server
+ * @param FEDid_name i.e. FED file name (may be a .fed or a
.xml file)
+ */
Federation(const char *, Handle, SocketServer &, AuditFile &, const
char *, int theVerboseLevel)
#endif
throw (CouldNotOpenFED, ErrorReadingFED, MemoryExhausted,
SecurityError,
@@ -598,4 +618,4 @@
#endif // _CERTI_RTIG_FEDERATION_HH
-// $Id: Federation.hh,v 3.53 2008/11/09 12:41:39 gotthardp Exp $
+// $Id: Federation.hh,v 3.54 2008/11/10 13:19:01 erk Exp $
Index: RTIG/main.cc
===================================================================
RCS file: /sources/certi/certi/RTIG/main.cc,v
retrieving revision 3.20
retrieving revision 3.21
diff -u -b -r3.20 -r3.21
--- RTIG/main.cc 6 Nov 2008 14:14:43 -0000 3.20
+++ RTIG/main.cc 10 Nov 2008 13:19:01 -0000 3.21
@@ -62,8 +62,9 @@
*
* The CERTI RunTime Infrastructure Gateway (RTIG) is a process which
* coordinate the HLA simulation with CERTI, there should be at least
- * one rtig process for each federation. However a single rtig may
- * be used for several federation.
+ * one rtig process for each federation. However a single RTIG may
+ * be used for several federations.
+ * The command line usage of the RTIG is following:
* \par rtig [-v 2]
* \par
* <ul>
@@ -75,6 +76,19 @@
* </ul>
* </ul>
*
+ * Once the RTIG is launched an HLA Federate may interact with the RTI.
+ * In fact a federate does not talk to the RTIG directly but it uses
+ * its \ref certi_executable_RTIA.
+ * RTIG is listening to \ref certi_executable_RTIA connection on TCP port:
+ * <ol>
+ * <li> 60400 or, </li>
+ * <li> the value of environment variable CERTI_TCP_PORT if it is
defined</li>
+ * </ol>
+ * The RTIG exchange messages with the \ref certi_executable_RTIA in order
+ * to satify HLA request coming from the Federate.
+ * In particular RTIG is responsible for giving to the Federate (through its
RTIA)
+ * the FOM file needed to create or join the federation.
+ * \copydoc certi_FOM_FileSearch
* @ingroup certi_executable
*/
int main(int argc, char *argv[])
Index: RTIG/Federation.cc
===================================================================
RCS file: /sources/certi/certi/RTIG/Federation.cc,v
retrieving revision 3.100
retrieving revision 3.101
diff -u -b -r3.100 -r3.101
--- RTIG/Federation.cc 9 Nov 2008 12:41:39 -0000 3.100
+++ RTIG/Federation.cc 10 Nov 2008 13:19:01 -0000 3.101
@@ -18,7 +18,7 @@
// along with this program ; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
-// $Id: Federation.cc,v 3.100 2008/11/09 12:41:39 gotthardp Exp $
+// $Id: Federation.cc,v 3.101 2008/11/10 13:19:01 erk Exp $
// ----------------------------------------------------------------------------
#include <config.h>
@@ -28,10 +28,6 @@
#include <cassert>
#include <memory>
-#ifdef _WIN32
-
-#endif
-
#include "fed.hh"
#include "XmlParser.hh"
#include "Object.hh"
@@ -88,19 +84,19 @@
static PrettyDebug D("FEDERATION", __FILE__);
static PrettyDebug G("GENDOC",__FILE__);
-// ----------------------------------------------------------------------------
-//! Constructor
-/*! Allocates memory the Name's storage, and read its FED file to store the
- result in RootObj.
-*/
+/**
+ * \defgroup certi_FOM_FileSearch CERTI FOM file search algorithm
+ * RTIG tries to open FOM file from different
+ * predefined places:
+ *
+ * -# bare filename considered as a path provided through FEDid_name
+ * -# getenv(CERTI_HOME)+"/share/federations"+ FEDid_name
+ * -# default (unix) installation place plus FEDid_name
+ * "/usr/local/share/federation/" + FEDid_name
+ */
+
#ifdef FEDERATION_USES_MULTICAST
-/** with FEDERATION_USES_MULTICAST defined
- @param federation_name
- @param federation_handle
- @param socket_server
- @param audit_server
- @param mc_link
-*/
+
Federation::Federation(const char *federation_name,
FederationHandle federation_handle,
SocketServer &socket_server,
@@ -108,13 +104,6 @@
SocketMC *mc_link,
int theVerboseLevel)
#else
-/** with FEDERATION_USES_MULTICAST not defined
- @param federation_name
- @param federation_handle
- @param socket_server
- @param audit_server
- @param FEDid_name i.e. FED file name (may be a .fed or a .xml file)
-*/
Federation::Federation(const char *federation_name,
Handle federation_handle,
SocketServer &socket_server,
@@ -2316,5 +2305,5 @@
}} // namespace certi/rtig
-// $Id: Federation.cc,v 3.100 2008/11/09 12:41:39 gotthardp Exp $
+// $Id: Federation.cc,v 3.101 2008/11/10 13:19:01 erk Exp $
Index: RTIA/main.cc
===================================================================
RCS file: /sources/certi/certi/RTIA/main.cc,v
retrieving revision 3.23
retrieving revision 3.24
diff -u -b -r3.23 -r3.24
--- RTIA/main.cc 18 Oct 2008 18:48:16 -0000 3.23
+++ RTIA/main.cc 10 Nov 2008 13:19:01 -0000 3.24
@@ -18,7 +18,7 @@
// along with this program ; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
-// $Id: main.cc,v 3.23 2008/10/18 18:48:16 gotthardp Exp $
+// $Id: main.cc,v 3.24 2008/11/10 13:19:01 erk Exp $
// ----------------------------------------------------------------------------
#include <config.h>
@@ -41,8 +41,9 @@
* @defgroup certi_executable_RTIA RTIA
*
* The CERTI RunTime Infrastructure Ambassador (RTIA) is a process
- * which is usually automatically launched by the federate as soon as its
+ * which is automatically launched by the federate as soon as its
* RTIambassador is created.
+ * The command line usage of the RTIA is following:
* \par rtia [-v] [-p \<port\>]
* \par
* <ul>
@@ -127,4 +128,4 @@
throw MemoryExhausted("RTIA has exhausted memory error");
}
-// EOF $Id: main.cc,v 3.23 2008/10/18 18:48:16 gotthardp Exp $
+// EOF $Id: main.cc,v 3.24 2008/11/10 13:19:01 erk Exp $
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [certi-cvs] certi doc/certi_user_doc.tree doc/certi_install...,
certi-cvs <=