Changeset 316 for cpp/frams

Timestamp:

01/27/15 23:13:10 (10 years ago)

Author:

Maciej Komosinski

Message:

Improved documentation (for Param flags in particular)

Location:

cpp/frams

Files:

• _demos/loader_test_param.cpp (modified) (1 diff)
• _demos/loader_test_param.in (modified) (1 diff)
• param/param.cpp (modified) (3 diffs)
• param/param.h (modified) (1 diff)

cpp/frams/_demos/loader_test_param.cpp

@@ -76 +76 @@
                 {
                 case MultiParamLoader::OnComment:
-                        fprintf(stderr, "comment: %s\n", (const char*)loader.getComment());
+                        fprintf(stderr, "comment: '%s'\n", (const char*)loader.getComment());
                         break;
 

cpp/frams/_demos/loader_test_param.in

@@ -1 @@
-#this is comment1
+#this is comment1  
 # this is comment2
 data:

cpp/frams/param/param.cpp

@@ -497 +497 @@
         case 'o':       ret.setObject(getObject(i)); break;
         case 'x':       ret = getExtValue(i); break;
-        default: FMprintf("ParamInterface", "get", FMLV_ERROR, "'%s.%s' is not mn field", getName(), id(i));
+        default: FMprintf("ParamInterface", "get", FMLV_ERROR, "'%s.%s' is not a field", getName(), id(i));
         }
 }
@@ -783 +783 @@
         while (*t) if (*t == ' ') break; else t++;
         if (sscanf(t, PA_INT_SCANF " " PA_INT_SCANF, &mn, &mx) == 2)
-                if (mn <= mx) // if max<min then the min/max constraint check is not supported
+                if (mn <= mx) // else if mn>mx then the min/max constraint makes no sense and there is no checking
                 {
                 if (x < mn) { x = mn; result = PSET_HITMIN; }
@@ -819 +819 @@
         while (*t) if (*t == ' ') break; else t++;
         if (sscanf(t, "%lg %lg", &mn, &mx) == 2)
-                if (mn <= mx) // if max<min then the min/max constraint check is not supported
+                if (mn <= mx) // else if mn>mx then the min/max constraint makes no sense and there is no checking
                 {
                 if (x < mn) { x = mn; result = PSET_HITMIN; }

cpp/frams/param/param.h

@@ -18 +18 @@
 
 // ParamInterface flags:
-#define PARAM_READONLY  1
-#define PARAM_DONTSAVE  2
-#define PARAM_SETLEVEL(x) (((x)&3)<<2)
-#define PARAM_LEVEL(x) (((x)>>2)&3)
-#define PARAM_USERREADONLY 16
-#define PARAM_USERHIDDEN 32
-// for mutableparam (private!)
-#define MUTPARAM_ALLOCENTRY 64
-#define MUTPARAM_ALLOCDATA 128
-#define PARAM_NOSTATIC 256
-#define PARAM_CONST 512
-#define PARAM_CANOMITNAME 1024
-#define PARAM_DONTLOAD  2048
-#define PARAM_NOISOLATION       4096
-#define PARAM_DEPRECATED        8192
+#define PARAM_READONLY       1  //< Param is not able to change this member
+#define PARAM_DONTSAVE       2  //< Param will not save this member
+#define PARAM_SETLEVEL(x) (((x)&3)<<2)  //< internal use
+#define PARAM_LEVEL(x)    (((x)>>2)&3)  //< internal use
+#define PARAM_USERREADONLY  16  //< GUI should not change this member (even if Param can)
+#define PARAM_USERHIDDEN    32  //< GUI should not display this member
+#define MUTPARAM_ALLOCENTRY 64  //< for mutableparam (private!)
+#define MUTPARAM_ALLOCDATA 128  //< for mutableparam (private!)
+#define PARAM_NOSTATIC  256     //< (FramScript) don't access this member in a static object (ClassName.field)
+#define PARAM_CONST     512     //< (FramScript) constant value
+#define PARAM_CANOMITNAME 1024  //< affects Param::save2()/load2() - for example one-liners in f0 genetic encoding
+#define PARAM_DONTLOAD    2048  //< Param::load() skips this field
+#define PARAM_NOISOLATION 4096  //< don't use proxy object in master/slave interactions
+#define PARAM_DEPRECATED  8192  //< this member is deprecated
 
 typedef int32_t paInt;