[Gcblue-commits] gcb_wx/src/scriptinterface tcPlatformInterface.cpp,1.13,1.13.2.1 tcSimPythonInterface.cpp,1.10,1.10.2.1

[<ddc...@us...>]

Update of /cvsroot/gcblue/gcb_wx/src/scriptinterface
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv32097/src/scriptinterface

Modified Files:
      Tag: v0_5_0
	tcPlatformInterface.cpp tcSimPythonInterface.cpp 
Log Message:


Index: tcPlatformInterface.cpp
===================================================================
RCS file: /cvsroot/gcblue/gcb_wx/src/scriptinterface/tcPlatformInterface.cpp,v
retrieving revision 1.13
retrieving revision 1.13.2.1
diff -C2 -d -r1.13 -r1.13.2.1
*** tcPlatformInterface.cpp	8 Jan 2004 23:54:27 -0000	1.13
--- tcPlatformInterface.cpp	17 Feb 2004 14:27:02 -0000	1.13.2.1
***************
*** 453,456 ****
--- 453,462 ----
  
      // sensor map commands
+ 
+     /**
+     * Get first track in alliance sensor map. As a work-around a tcTrackIterator object
+     * is returned that has the track info along with an index that is used to iterate
+     * through tracks. This will be simplified in the future.
+     */
      tcTrackIterator tcPlatformInterface::GetFirstTrack(void) {
          tcTrackIterator t;

Index: tcSimPythonInterface.cpp
===================================================================
RCS file: /cvsroot/gcblue/gcb_wx/src/scriptinterface/tcSimPythonInterface.cpp,v
retrieving revision 1.10
retrieving revision 1.10.2.1
diff -C2 -d -r1.10 -r1.10.2.1
*** tcSimPythonInterface.cpp	29 Dec 2003 01:10:25 -0000	1.10
--- tcSimPythonInterface.cpp	17 Feb 2004 14:27:02 -0000	1.10.2.1
***************
*** 46,49 ****
--- 46,54 ----
  namespace ScriptInterface 
  {
+     /**
+     * Adds a menu item with command string
+     * @param caption caption for menu item
+     * @param command command string for item
+     */
      void tcMenuInterface::AddItem(std::string caption, std::string command) 
      {
***************
*** 51,54 ****
--- 56,65 ----
          mpMenu->AddItem(caption, command);
      }
+     /**
+     * Adds a menu item with command string and command parameter
+     * @param caption caption for menu item
+     * @param command command string for item
+     * @param param integer command parameter
+     */
      void tcMenuInterface::AddItemWithParam(std::string caption, std::string command, int param) 
      {
***************
*** 56,59 ****
--- 67,76 ----
          mpMenu->AddItem(caption, command, param);
      }
+     /**
+     * Adds a menu item that gets a coordinate or target from the user via a mouse click
+     * @param caption caption for menu item
+     * @param callback script to call after user data is obtained
+     * @param input type of user data: "Heading", "Target", or "Datum"
+     */
      void tcMenuInterface::AddItemUI(std::string caption, std::string callback, std::string input) 
      {
***************
*** 61,64 ****
--- 78,88 ----
      }
  
+     /**
+     * Adds a menu item that gets a coordinate or target from the user via a mouse click
+     * @param caption caption for menu item
+     * @param callback script to call after user data is obtained
+     * @param input type of user data: "Heading", "Target", or "Datum"
+     * @param param integer callback parameter for additional information
+     */
      void tcMenuInterface::AddItemUIWithParam(std::string caption, std::string callback, 
          std::string input, int param)
***************
*** 74,77 ****
--- 98,104 ----
      }
  
+     /**
+     * Begin a submenu in current menu
+     */
      void tcMenuInterface::BeginSubMenu(void) {
          if (mpMenu == NULL) {return;}
***************
*** 79,82 ****
--- 106,112 ----
      }
  
+     /**
+     * Clear menu
+     */
      void tcMenuInterface::Clear(void) {
          if (mpMenu == NULL) {return;}
***************
*** 84,87 ****
--- 114,120 ----
      }
  
+     /**
+     * End submenu in current menu
+     */
      void tcMenuInterface::EndSubMenu(void) {
          if (mpMenu == NULL) {return;}