[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[certi-cvs] certi doc/certi_user.cnf.in doc/certi_user_doc....
|
From: |
certi-cvs |
|
Subject: |
[certi-cvs] certi doc/certi_user.cnf.in doc/certi_user_doc.... |
|
Date: |
Wed, 24 Jun 2009 12:33:31 +0000 |
CVSROOT: /sources/certi
Module name: certi
Changes by: Petr Gotthard <gotthardp> 09/06/24 12:33:31
Modified files:
doc : certi_user.cnf.in certi_user_doc.tree
libHLA : HLAbasicType.hh HLAenumeratedType.hh
HLAfixedArray.hh HLAfixedRecord.hh
HLAtypesIEEE1516.hh HLAvariableArray.hh
HLAvariantRecord.hh
Log message:
Bug #24735: First draft of libHLA documentation.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user.cnf.in?cvsroot=certi&r1=3.8&r2=3.9
http://cvs.savannah.gnu.org/viewcvs/certi/doc/certi_user_doc.tree?cvsroot=certi&r1=3.5&r2=3.6
http://cvs.savannah.gnu.org/viewcvs/certi/libHLA/HLAbasicType.hh?cvsroot=certi&r1=1.4&r2=1.5
http://cvs.savannah.gnu.org/viewcvs/certi/libHLA/HLAenumeratedType.hh?cvsroot=certi&r1=1.2&r2=1.3
http://cvs.savannah.gnu.org/viewcvs/certi/libHLA/HLAfixedArray.hh?cvsroot=certi&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/certi/libHLA/HLAfixedRecord.hh?cvsroot=certi&r1=1.2&r2=1.3
http://cvs.savannah.gnu.org/viewcvs/certi/libHLA/HLAtypesIEEE1516.hh?cvsroot=certi&r1=1.4&r2=1.5
http://cvs.savannah.gnu.org/viewcvs/certi/libHLA/HLAvariableArray.hh?cvsroot=certi&r1=1.3&r2=1.4
http://cvs.savannah.gnu.org/viewcvs/certi/libHLA/HLAvariantRecord.hh?cvsroot=certi&r1=1.1&r2=1.2
Patches:
Index: doc/certi_user.cnf.in
===================================================================
RCS file: /sources/certi/certi/doc/certi_user.cnf.in,v
retrieving revision 3.8
retrieving revision 3.9
diff -u -b -r3.8 -r3.9
--- doc/certi_user.cnf.in 10 Nov 2008 13:19:00 -0000 3.8
+++ doc/certi_user.cnf.in 24 Jun 2009 12:33:30 -0000 3.9
@@ -438,6 +438,13 @@
"${CMAKE_SOURCE_DIR}/doc/introduction.dox" \
"${CMAKE_SOURCE_DIR}/doc/execute.dox" \
"${CMAKE_SOURCE_DIR}/libCERTI/SocketHTTPProxy.cc" \
+ "${CMAKE_SOURCE_DIR}/libHLA/HLAtypesIEEE1516.hh" \
+ "${CMAKE_SOURCE_DIR}/libHLA/HLAbasicType.hh" \
+ "${CMAKE_SOURCE_DIR}/libHLA/HLAenumeratedType.hh" \
+ "${CMAKE_SOURCE_DIR}/libHLA/HLAfixedArray.hh" \
+ "${CMAKE_SOURCE_DIR}/libHLA/HLAfixedRecord.hh" \
+ "${CMAKE_SOURCE_DIR}/libHLA/HLAvariableArray.hh" \
+ "${CMAKE_SOURCE_DIR}/libHLA/HLAvariantRecord.hh" \
"${CMAKE_SOURCE_DIR}/RTIG/main.cc" \
"${CMAKE_SOURCE_DIR}/RTIG/Federation.cc" \
"${CMAKE_SOURCE_DIR}/RTIA/main.cc"
Index: doc/certi_user_doc.tree
===================================================================
RCS file: /sources/certi/certi/doc/certi_user_doc.tree,v
retrieving revision 3.5
retrieving revision 3.6
diff -u -b -r3.5 -r3.6
--- doc/certi_user_doc.tree 10 Nov 2008 13:19:00 -0000 3.5
+++ doc/certi_user_doc.tree 24 Jun 2009 12:33:31 -0000 3.6
@@ -34,8 +34,17 @@
* <ul>
* <li>\ref intro</li>
* <li>\ref execute</li>
+ * <li>\ref certi_HLAtypesIEEE1516</li>
+ * <ul>
+ * <li>\ref certi_HLAbasicType</li>
+ * <li>\ref certi_HLAenumeratedType</li>
+ * <li>\ref certi_HLAfixedArray</li>
+ * <li>\ref certi_HLAfixedRecord</li>
+ * <li>\ref certi_HLAvariableArray</li>
+ * <li>\ref certi_HLAvariantRecord</li>
+ * </ul>
* </ul>
*
*/
-// $Id: certi_user_doc.tree,v 3.5 2008/11/10 13:19:00 erk Exp $
+// $Id: certi_user_doc.tree,v 3.6 2009/06/24 12:33:31 gotthardp Exp $
Index: libHLA/HLAbasicType.hh
===================================================================
RCS file: /sources/certi/certi/libHLA/HLAbasicType.hh,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- libHLA/HLAbasicType.hh 18 Nov 2008 17:38:59 -0000 1.4
+++ libHLA/HLAbasicType.hh 24 Jun 2009 12:33:31 -0000 1.5
@@ -11,7 +11,7 @@
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
-// $Id: HLAbasicType.hh,v 1.4 2008/11/18 17:38:59 gotthardp Exp $
+// $Id: HLAbasicType.hh,v 1.5 2009/06/24 12:33:31 gotthardp Exp $
// ----------------------------------------------------------------------------
#ifndef _HLATYPES_BASICTYPE_HH
@@ -22,8 +22,14 @@
namespace libhla {
-/* HLAbasicType<DATATYPE, STORAGE, ENCODING>
- * defines a user-convenient DATATYPE, stored in STORAGE using given ENCODING.
+/**
+ * @page certi_HLAbasicType Basic Types
+ *
+ * The template
+\verbatim
+ HLAbasicType<DATATYPE, STORAGE, ENCODING>
+\endverbatim
+ * defines a user-convenient \p DATATYPE, stored in \p STORAGE using given \p
ENCODING.
*
* The data are stored in a buffer of sizeof(STORAGE).
*
@@ -32,10 +38,12 @@
* The DATATYPE may have any sizeof(), but must have static-cast to STORAGE.
*
* For example:
- * typedef HLAbasicType<long, uint32_t, LittleEndian> HLAinteger32BE;
- * HLAdata<HLAinteger32BE> value;
- *
- * value = 42;
+\verbatim
+ typedef HLAbasicType<long, uint32_t, LittleEndian> HLAinteger32BE;
+ HLAdata<HLAinteger32BE> value;
+
+ value = 42;
+\endverbatim
*/
//! Swap <i> bytes of the <T> type
@@ -128,7 +136,7 @@
}
};
-//! HLA basic type, represented by <T> type stored in <S> using <E> encoding.
+// HLA basic type, represented by <T> type stored in <S> using <E> encoding.
template<class T, class S, template<class T>class E>
struct HLAbasicType
{
@@ -207,5 +215,5 @@
#endif // _HLATYPES_BASICTYPE_HH
-// $Id: HLAbasicType.hh,v 1.4 2008/11/18 17:38:59 gotthardp Exp $
+// $Id: HLAbasicType.hh,v 1.5 2009/06/24 12:33:31 gotthardp Exp $
Index: libHLA/HLAenumeratedType.hh
===================================================================
RCS file: /sources/certi/certi/libHLA/HLAenumeratedType.hh,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- libHLA/HLAenumeratedType.hh 3 Nov 2008 11:10:58 -0000 1.2
+++ libHLA/HLAenumeratedType.hh 24 Jun 2009 12:33:31 -0000 1.3
@@ -11,7 +11,7 @@
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
-// $Id: HLAenumeratedType.hh,v 1.2 2008/11/03 11:10:58 gotthardp Exp $
+// $Id: HLAenumeratedType.hh,v 1.3 2009/06/24 12:33:31 gotthardp Exp $
// ----------------------------------------------------------------------------
#ifndef _HLATYPES_ENUMERATEDTYPE_HH
@@ -19,7 +19,13 @@
namespace libhla {
-/* HLAenumeratedType<ENUMERATION, REPRESENTATION>
+/**
+ * @page certi_HLAenumeratedType Enumeration Types
+ *
+ * The template
+\verbatim
+ HLAenumeratedType<ENUMERATION, REPRESENTATION>
+\endverbatim
* defines an user-convenient ENUMERATION stored using given REPRESENTATION.
*
* The data can be accessed in an usual way.
@@ -28,27 +34,29 @@
* name collisions it's recommended to put the ENUMERATION in an individual
namespace.
*
* For example:
- * +------------+----------------+------------+--------+-----------+
- * | Name | Representation | Enumerator | Values | Semantics |
- * +------------+----------------+------------+--------+-----------+
- * | | | HLAfalse | 0 | |
- * | HLAboolean | HLAinteger32BE +------------+--------+-----------+
- * | | | HLAfalse | 1 | |
- * +------------+----------------+------------+--------+-----------+
- *
- * namespace __HLAboolean {
- * enum __enum {
- * HLAfalse = 0,
- * HLAtrue = 1
- * };
- * }
- * typedef HLAenumeratedType<__HLAboolean::__enum, HLAinteger32BE> HLAboolean;
- * HLAdata<HLAboolean> value;
- *
- * value = HLAtrue;
+\verbatim
+ +------------+----------------+------------+--------+-----------+
+ | Name | Representation | Enumerator | Values | Semantics |
+ +------------+----------------+------------+--------+-----------+
+ | | | HLAfalse | 0 | |
+ | HLAboolean | HLAinteger32BE +------------+--------+-----------+
+ | | | HLAfalse | 1 | |
+ +------------+----------------+------------+--------+-----------+
+
+ namespace __HLAboolean {
+ enum __enum {
+ HLAfalse = 0,
+ HLAtrue = 1
+ };
+ }
+ typedef HLAenumeratedType<__HLAboolean::__enum, HLAinteger32BE> HLAboolean;
+ HLAdata<HLAboolean> value;
+
+ value = HLAtrue;
+\endverbatim
*/
-//! HLA enumerated type, enumeration <E> with representation <R>.
+// HLA enumerated type, enumeration <E> with representation <R>.
template<class E, class R>
struct HLAenumeratedType
{
@@ -99,5 +107,5 @@
#endif // _HLATYPES_ENUMERATEDTYPE_HH
-// $Id: HLAenumeratedType.hh,v 1.2 2008/11/03 11:10:58 gotthardp Exp $
+// $Id: HLAenumeratedType.hh,v 1.3 2009/06/24 12:33:31 gotthardp Exp $
Index: libHLA/HLAfixedArray.hh
===================================================================
RCS file: /sources/certi/certi/libHLA/HLAfixedArray.hh,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- libHLA/HLAfixedArray.hh 2 Aug 2008 14:03:14 -0000 1.1
+++ libHLA/HLAfixedArray.hh 24 Jun 2009 12:33:31 -0000 1.2
@@ -11,7 +11,7 @@
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
-// $Id: HLAfixedArray.hh,v 1.1 2008/08/02 14:03:14 gotthardp Exp $
+// $Id: HLAfixedArray.hh,v 1.2 2009/06/24 12:33:31 gotthardp Exp $
// ----------------------------------------------------------------------------
#ifndef _HLATYPES_FIXEDARRAY_HH
@@ -21,23 +21,31 @@
namespace libhla {
-/* HLAfixedArray<DATATYPE, NUMBER>
+/**
+ * @page certi_HLAfixedArray Fixed Array
+ *
+ * The template
+\verbatim
+ HLAfixedArray<DATATYPE, NUMBER>
+\endverbatim
* defines a fixed array of NUMBER elements of type DATATYPE.
*
* The data can be accessed in an usual way.
*
* For example:
- * +-------------+----------------+-------------+-----------------+-----------+
- * | Name | Element type | Cardinality | Encoding | Semantics |
- * +-------------+----------------+-------------+-----------------+-----------+
- * | Coordinates | HLAinteger32BE | 3 | HLAfixedArray | |
- * +-------------+----------------+-------------+-----------------+-----------+
- *
- * typedef HLAfixedArray<HLAinteger32BE,3> Coordinates;
- * HLAdata<Coordinates> value;
- *
- * (*value)[0] = 100;
- * (*value)[1] = 200;
+\verbatim
+ +-------------+----------------+-------------+-----------------+-----------+
+ | Name | Element type | Cardinality | Encoding | Semantics |
+ +-------------+----------------+-------------+-----------------+-----------+
+ | Coordinates | HLAinteger32BE | 3 | HLAfixedArray | |
+ +-------------+----------------+-------------+-----------------+-----------+
+
+ typedef HLAfixedArray<HLAinteger32BE,3> Coordinates;
+ HLAdata<Coordinates> value;
+
+ (*value)[0] = 100;
+ (*value)[1] = 200;
+\endverbatim
*/
//! Fixed array of <N> elements of type <M>
@@ -150,5 +158,5 @@
#endif // _HLATYPES_FIXEDARRAY_HH
-// $Id: HLAfixedArray.hh,v 1.1 2008/08/02 14:03:14 gotthardp Exp $
+// $Id: HLAfixedArray.hh,v 1.2 2009/06/24 12:33:31 gotthardp Exp $
Index: libHLA/HLAfixedRecord.hh
===================================================================
RCS file: /sources/certi/certi/libHLA/HLAfixedRecord.hh,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -b -r1.2 -r1.3
--- libHLA/HLAfixedRecord.hh 11 Oct 2008 09:35:51 -0000 1.2
+++ libHLA/HLAfixedRecord.hh 24 Jun 2009 12:33:31 -0000 1.3
@@ -11,7 +11,7 @@
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
-// $Id: HLAfixedRecord.hh,v 1.2 2008/10/11 09:35:51 gotthardp Exp $
+// $Id: HLAfixedRecord.hh,v 1.3 2009/06/24 12:33:31 gotthardp Exp $
// ----------------------------------------------------------------------------
#ifndef _HLATYPES_FIXEDRECORD_HH
@@ -21,44 +21,52 @@
namespace libhla {
-/* HLAfixedRecord<
- * HLAfixedField<INDEX1, DATATYPE1,
- * HLAfixedField<INDEX2, DATATYPE2,
- * ...
- * > ... > TYPENAME;
+/**
+ * @page certi_HLAfixedRecord Fixed Record
+ *
+ * The template
+\verbatim
+ HLAfixedRecord<
+ HLAfixedField<INDEX1, DATATYPE1,
+ HLAfixedField<INDEX2, DATATYPE2,
+ ...
+ > ... > TYPENAME;
+\endverbatim
* defines an ordered sequence of DATATYPE entries.
*
* The data can be accessed using the field<INDEX>() function. The INDEX is a
logical
* identifier only. The data are stored in the declaration order.
*
* For example:
- *
+-------------+------------------------------------+----------------+-----------+
- * | | Field | |
|
- * | Record name +---------+--------------+-----------+ Encoding |
Semantics |
- * | | Name | Type | Semantics | |
|
- *
+-------------+---------+--------------+-----------+----------------+-----------+
- * | | FIELD_X | HLAfloat32LE | | |
|
- * | +---------+--------------+-----------+ |
|
- * | Coordinates | FIELD_Y | HLAfloat32LE | | HLAfixedRecord |
|
- * | +---------+--------------+-----------+ |
|
- * | | FIELD_Z | HLAfloat32LE | | |
|
- *
+-------------+---------+--------------+-----------+----------------+-----------+
- *
- * enum {
- * FIELD_X = 0,
- * FIELD_Y,
- * FIELD_Z
- * };
- * typedef HLAfixedRecord<
- * HLAfixedField<FIELD_X, HLAfloat32LE,
- * HLAfixedField<FIELD_Y, HLAfloat32LE,
- * HLAfixedField<FIELD_Z, HLAfloat32LE
- * > > > > Coordinates;
- * HLAdata<Coordinates> value;
- *
- * value->field<FIELD_X>() = 3.14;
- * value->field<FIELD_Y>() = 6.28;
- * value->field<FIELD_Z>() = 9.42;
+\verbatim
+
+-------------+------------------------------------+----------------+-----------+
+ | | Field | |
|
+ | Record name +---------+--------------+-----------+ Encoding |
Semantics |
+ | | Name | Type | Semantics | |
|
+
+-------------+---------+--------------+-----------+----------------+-----------+
+ | | FIELD_X | HLAfloat32LE | | |
|
+ | +---------+--------------+-----------+ |
|
+ | Coordinates | FIELD_Y | HLAfloat32LE | | HLAfixedRecord |
|
+ | +---------+--------------+-----------+ |
|
+ | | FIELD_Z | HLAfloat32LE | | |
|
+
+-------------+---------+--------------+-----------+----------------+-----------+
+
+ enum {
+ FIELD_X = 0,
+ FIELD_Y,
+ FIELD_Z
+ };
+ typedef HLAfixedRecord<
+ HLAfixedField<FIELD_X, HLAfloat32LE,
+ HLAfixedField<FIELD_Y, HLAfloat32LE,
+ HLAfixedField<FIELD_Z, HLAfloat32LE
+ > > > > Coordinates;
+ HLAdata<Coordinates> value;
+
+ value->field<FIELD_X>() = 3.14;
+ value->field<FIELD_Y>() = 6.28;
+ value->field<FIELD_Z>() = 9.42;
+\endverbatim
*/
//! Fixed record of fields <R>
@@ -267,5 +275,5 @@
#endif // _HLATYPES_FIXEDRECORD_HH
-// $Id: HLAfixedRecord.hh,v 1.2 2008/10/11 09:35:51 gotthardp Exp $
+// $Id: HLAfixedRecord.hh,v 1.3 2009/06/24 12:33:31 gotthardp Exp $
Index: libHLA/HLAtypesIEEE1516.hh
===================================================================
RCS file: /sources/certi/certi/libHLA/HLAtypesIEEE1516.hh,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- libHLA/HLAtypesIEEE1516.hh 2 Aug 2008 14:03:14 -0000 1.4
+++ libHLA/HLAtypesIEEE1516.hh 24 Jun 2009 12:33:31 -0000 1.5
@@ -11,17 +11,35 @@
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
-// $Id: HLAtypesIEEE1516.hh,v 1.4 2008/08/02 14:03:14 gotthardp Exp $
+// $Id: HLAtypesIEEE1516.hh,v 1.5 2009/06/24 12:33:31 gotthardp Exp $
// ----------------------------------------------------------------------------
#ifndef _HLATYPES_IEEE1516_HH
#define _HLATYPES_IEEE1516_HH
-/* These templates implement efficient access functions that provide direct
- * access to IEEE 1516.2 compliant data buffers.
+/**
+ * @page certi_HLAtypesIEEE1516 IEEE 1516.2 Data Encoding Functions
+ *
+ * These templates implement efficient access functions that provide direct
+ * access to IEEE 1516.2 compliant data buffers. The functions are RTI
+ * independent and thus compatible with any RTI.
* The data are manipulated "in situ", no temporary variables are created.
*
- * Use hlaomtdif2cpp -i <file> to generate FOM/SOM specific datatypes.
+ * Use
+\verbatim
+ hlaomtdif2cpp -i <file>
+\endverbatim
+ * to generate FOM/SOM specific datatypes.
+ *
+ * The following templates are provided:
+ * <ul>
+ * <li>\ref certi_HLAbasicType</li>
+ * <li>\ref certi_HLAenumeratedType</li>
+ * <li>\ref certi_HLAfixedArray</li>
+ * <li>\ref certi_HLAfixedRecord</li>
+ * <li>\ref certi_HLAvariableArray</li>
+ * <li>\ref certi_HLAvariantRecord</li>
+ * </ul>
*
* The extensive use of template metaprogramming allows many operations to
* be pre-calculated during compile-time.
@@ -102,5 +120,5 @@
#endif // _HLATYPES_IEEE1516_HH
-// $Id: HLAtypesIEEE1516.hh,v 1.4 2008/08/02 14:03:14 gotthardp Exp $
+// $Id: HLAtypesIEEE1516.hh,v 1.5 2009/06/24 12:33:31 gotthardp Exp $
Index: libHLA/HLAvariableArray.hh
===================================================================
RCS file: /sources/certi/certi/libHLA/HLAvariableArray.hh,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -b -r1.3 -r1.4
--- libHLA/HLAvariableArray.hh 4 Nov 2008 14:40:39 -0000 1.3
+++ libHLA/HLAvariableArray.hh 24 Jun 2009 12:33:31 -0000 1.4
@@ -11,7 +11,7 @@
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
-// $Id: HLAvariableArray.hh,v 1.3 2008/11/04 14:40:39 gotthardp Exp $
+// $Id: HLAvariableArray.hh,v 1.4 2009/06/24 12:33:31 gotthardp Exp $
// ----------------------------------------------------------------------------
#ifndef _HLATYPES_VARIABLEARRAY_HH
@@ -22,25 +22,33 @@
namespace libhla {
-/* HLAvariableArray<DATATYPE>
+/**
+ * @page certi_HLAvariableArray Variable Array
+ *
+ * The template
+\verbatim
+ HLAvariableArray<DATATYPE>
+\endverbatim
* defines an array of a variable number of DATATYPE elements.
*
* The size() member must be set before accessing the data. No data are moved
* when the size() is changed.
*
* For example:
- * +-------------+----------------+-------------+-----------------+-----------+
- * | Name | Element type | Cardinality | Encoding | Semantics |
- * +-------------+----------------+-------------+-----------------+-----------+
- * | List | HLAinteger32BE | Dynamic | HLAvaribleArray | |
- * +-------------+----------------+-------------+-----------------+-----------+
- *
- * typedef HLAvariableArray<HLAinteger32BE> List;
- * HLAdata<List> value;
- *
- * (*value).set_size(2);
- * (*value)[0] = 100;
- * (*value)[1] = 200;
+\verbatim
+ +-------------+----------------+-------------+-----------------+-----------+
+ | Name | Element type | Cardinality | Encoding | Semantics |
+ +-------------+----------------+-------------+-----------------+-----------+
+ | List | HLAinteger32BE | Dynamic | HLAvaribleArray | |
+ +-------------+----------------+-------------+-----------------+-----------+
+
+ typedef HLAvariableArray<HLAinteger32BE> List;
+ HLAdata<List> value;
+
+ (*value).set_size(2);
+ (*value)[0] = 100;
+ (*value)[1] = 200;
+\endverbatim
*/
//! Variable array of type <M>
@@ -241,5 +249,5 @@
#endif // _HLATYPES_VARIABLEARRAY_HH
-// $Id: HLAvariableArray.hh,v 1.3 2008/11/04 14:40:39 gotthardp Exp $
+// $Id: HLAvariableArray.hh,v 1.4 2009/06/24 12:33:31 gotthardp Exp $
Index: libHLA/HLAvariantRecord.hh
===================================================================
RCS file: /sources/certi/certi/libHLA/HLAvariantRecord.hh,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- libHLA/HLAvariantRecord.hh 2 Aug 2008 14:03:15 -0000 1.1
+++ libHLA/HLAvariantRecord.hh 24 Jun 2009 12:33:31 -0000 1.2
@@ -11,7 +11,7 @@
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
-// $Id: HLAvariantRecord.hh,v 1.1 2008/08/02 14:03:15 gotthardp Exp $
+// $Id: HLAvariantRecord.hh,v 1.2 2009/06/24 12:33:31 gotthardp Exp $
// ----------------------------------------------------------------------------
#ifndef _HLATYPES_VARIANTRECORD_HH
@@ -21,12 +21,18 @@
namespace libhla {
-/* HLAvariantRecord<
- * INDEX, DATATYPE,
- * HLAvariantField<ENUMERATORS1, INDEX1, DATATYPE1,
- * HLAvariantField<ENUMERATORS2, INDEX2, DATATYPE2,
- * ...
- * > ... > TYPENAME;
+/**
+ * @page certi_HLAvariantRecord Variant Record
+ *
+ * The template
+\verbatim
+ HLAvariantRecord<
+ INDEX, DATATYPE,
+ HLAvariantField<ENUMERATORS1, INDEX1, DATATYPE1,
+ HLAvariantField<ENUMERATORS2, INDEX2, DATATYPE2,
+ ...
+ > ... > TYPENAME;
+\endverbatim
* defines an ordered sequence of DATATYPE entries.
*
* The data can be accessed using the field<INDEX>() function. The INDEX is a
logical
@@ -35,33 +41,35 @@
* ENUMERATORS match the discriminant value.
*
* For example:
- *
+-------------+-------------------------------+------------------------------------+------------------+-----------+
- * | | Discriminant | Alternative
| | |
- * | Record name
+------+-----------+------------+---------+--------------+-----------+ Encoding
| Semantics |
- * | | Name | Type | Enumerator | Name | Type |
Semantics | | |
- *
+-------------+------+-----------+------------+---------+--------------+-----------+------------------+-----------+
- * | | | | AXIS_X | FIELD_X | HLAfloat32LE |
| | |
- * | Coordinates | TYPE | TypesEnum
+------------+---------+--------------+-----------+ HLAvariantRecord |
|
- * | | | | AXIS_Y | FIELD_Y | HLAfloat32LE |
| | |
- *
+-------------+------+-----------+------------+---------+--------------+-----------+------------------+-----------+
- *
- * namespace __Fields {
- * enum __enum {
- * TYPE = 0,
- * FIELD_X = 101,
- * FIELD_Y = 102
- * };
- * }
- * typedef HLAenumeratedType<__Fields::__enum, HLAinteger32BE> Fields;
- * typedef HLAvariantRecord<
- * __Fields::TYPE, TypesEnum,
- * HLAvariantField<HLAsetValue<AXIS_X>, __Fields::FIELD_X, HLAfloat32LE,
- * HLAvariantField<HLAsetValue<AXIS_Y>, __Fields::FIELD_Y, HLAfloat32LE
- * > > > Coordinates;
- * HLAdata<Coordinates> value;
- *
- * value->set_discriminant(AXIS_X);
- * value->field<__Fields::FIELD_X>() = 3.14;
+\verbatim
+
+-------------+-------------------------------+------------------------------------+------------------+-----------+
+ | | Discriminant | Alternative
| | |
+ | Record name
+------+-----------+------------+---------+--------------+-----------+ Encoding
| Semantics |
+ | | Name | Type | Enumerator | Name | Type |
Semantics | | |
+
+-------------+------+-----------+------------+---------+--------------+-----------+------------------+-----------+
+ | | | | AXIS_X | FIELD_X | HLAfloat32LE |
| | |
+ | Coordinates | TYPE | TypesEnum
+------------+---------+--------------+-----------+ HLAvariantRecord |
|
+ | | | | AXIS_Y | FIELD_Y | HLAfloat32LE |
| | |
+
+-------------+------+-----------+------------+---------+--------------+-----------+------------------+-----------+
+
+ namespace __Fields {
+ enum __enum {
+ TYPE = 0,
+ FIELD_X = 101,
+ FIELD_Y = 102
+ };
+ }
+ typedef HLAenumeratedType<__Fields::__enum, HLAinteger32BE> Fields;
+ typedef HLAvariantRecord<
+ __Fields::TYPE, TypesEnum,
+ HLAvariantField<HLAsetValue<AXIS_X>, __Fields::FIELD_X, HLAfloat32LE,
+ HLAvariantField<HLAsetValue<AXIS_Y>, __Fields::FIELD_Y, HLAfloat32LE
+ > > > Coordinates;
+ HLAdata<Coordinates> value;
+
+ value->set_discriminant(AXIS_X);
+ value->field<__Fields::FIELD_X>() = 3.14;
+\endverbatim
*/
//! Variant record of discriminant <D> at index <E> and alternatives <R>
@@ -396,5 +404,5 @@
#endif // _HLATYPES_VARIANTRECORD_HH
-// $Id: HLAvariantRecord.hh,v 1.1 2008/08/02 14:03:15 gotthardp Exp $
+// $Id: HLAvariantRecord.hh,v 1.2 2009/06/24 12:33:31 gotthardp Exp $
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [certi-cvs] certi doc/certi_user.cnf.in doc/certi_user_doc....,
certi-cvs <=