Use better method names and add comments

diff --git a/simgear/nasal/cppbind/Ghost.hxx b/simgear/nasal/cppbind/Ghost.hxx
index 6a8ccfb8bf4a85c16659ea033fa3aedd73efd379..cfb6a960bc830d9ba45e33affe85a5b7e8798424 100644 (file)
--- a/simgear/nasal/cppbind/Ghost.hxx
+++ b/simgear/nasal/cppbind/Ghost.hxx
@@ -229,8 +229,16 @@ namespace nasal
       args(args)
     {}
 
+    /**
+     * Get the argument with given index if it exists. Otherwise returns the
+     * passed default value.
+     *
+     * @tparam T    Type of argument (converted using ::from_nasal)
+     * @param index Index of requested argument
+     * @param def   Default value returned if too few arguments available
+     */
     template<class T>
-    T get(size_t index, const T& def = T()) const
+    T getArg(size_t index, const T& def = T()) const
     {
       if( index >= argc )
         return def;
@@ -238,8 +246,12 @@ namespace nasal
       return from_nasal<T>(c, args[index]);
     }
 
+    /**
+     * Get the argument with given index. Raises a Nasal runtime error if there
+     * are to few arguments available.
+     */
     template<class T>
-    T require(size_t index) const
+    T requireArg(size_t index) const
     {
       if( index >= argc )
         naRuntimeError(c, "Missing required arg #%d", index);

diff --git a/simgear/nasal/cppbind/cppbind_test.cxx b/simgear/nasal/cppbind/cppbind_test.cxx
index 0f0caedf5d148ad5a6bef84425e8f9b6da561f12..1ff01973b83f29c33a9c84ed381e85b95ce56a11 100644 (file)
--- a/simgear/nasal/cppbind/cppbind_test.cxx
+++ b/simgear/nasal/cppbind/cppbind_test.cxx
@@ -157,9 +157,9 @@ int main(int argc, char* argv[])
     to_nasal(c, std::string("test-arg"))
   };
   CallContext cc(c, sizeof(args)/sizeof(args[0]), args);
-  VERIFY( cc.require<std::string>(0) == "test-arg" );
-  VERIFY( cc.get<std::string>(0) == "test-arg" );
-  VERIFY( cc.get<std::string>(1) == "" );
+  VERIFY( cc.requireArg<std::string>(0) == "test-arg" );
+  VERIFY( cc.getArg<std::string>(0) == "test-arg" );
+  VERIFY( cc.getArg<std::string>(1) == "" );
 
   // TODO actually do something with the ghosts...