summaryrefslogtreecommitdiff
path: root/examples/Persistent_Grid/Grid_Client_i.h
diff options
context:
space:
mode:
Diffstat (limited to 'examples/Persistent_Grid/Grid_Client_i.h')
-rw-r--r--examples/Persistent_Grid/Grid_Client_i.h67
1 files changed, 33 insertions, 34 deletions
diff --git a/examples/Persistent_Grid/Grid_Client_i.h b/examples/Persistent_Grid/Grid_Client_i.h
index 082c0d87bbb..1183592b637 100644
--- a/examples/Persistent_Grid/Grid_Client_i.h
+++ b/examples/Persistent_Grid/Grid_Client_i.h
@@ -1,21 +1,18 @@
// -*- C++ -*-
-// $Id$
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO/examples/Simple/grid
-//
-// = FILENAME
-// Grid_Client_i.h
-//
-// = DESCRIPTION
-// This class implements the interface calls for RMI.
-//
-// = AUTHOR
-// Balachandran Natarajan <bala@cs.wustl.edu>
-//
-// ============================================================================
+
+//=============================================================================
+/**
+ * @file Grid_Client_i.h
+ *
+ * $Id$
+ *
+ * This class implements the interface calls for RMI.
+ *
+ *
+ * @author Balachandran Natarajan <bala@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef GRID_CLIENT_I_H
#define GRID_CLIENT_I_H
@@ -23,49 +20,51 @@
#include "Simple_util.h"
#include "GridC.h"
+/**
+ * @class Grid_Client_i
+ *
+ * @brief Grid_Client interface subclass.
+ *
+ * This class implements the interface between the interface
+ * objects and the client .
+ */
class Grid_Client_i
{
- // = TITLE
- // Grid_Client interface subclass.
- //
- // = DESCRIPTION
- // This class implements the interface between the interface
- // objects and the client .
public:
// = Initialization and termination methods.
+ /// Constructor
Grid_Client_i (void);
- // Constructor
+ /// Destructor
virtual ~Grid_Client_i (void);
- // Destructor
+ /// Execute the methods.
virtual int run (const char *, int, ACE_TCHAR *[]);
- // Execute the methods.
+ /// Parses the command line arguments.
virtual int parse_args (int argc, ACE_TCHAR *argv[]);
- // Parses the command line arguments.
private:
+ /// Instantiate the client object.
Client<Grid_Factory, Grid_Factory_var> client;
- // Instantiate the client object.
+ /// Height of the grid.
CORBA::Short height_;
- // Height of the grid.
+ /// Width of the grid.
CORBA::Short width_;
- // Width of the grid.
+ /// Cell identifier in which a value meeds to be stored.
CORBA::Short setx_;
- // Cell identifier in which a value meeds to be stored.
+ /// Cell identifier in which a value meeds to be stored.
CORBA::Short sety_;
- // Cell identifier in which a value meeds to be stored.
+ /// The value that needs to be stored in the cell.
CORBA::Long value_;
- // The value that needs to be stored in the cell.
+ /// A flag for testing persistence
CORBA::Short repeat_;
- // A flag for testing persistence
};
#endif /* TIME_CLIENT_I_H */