document how a GlobalValue can be set from the command-line and with an environment variable
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Thu Jul 02 15:32:37 2009 +0200 (7 months ago)
changeset 46404c31bd451928
parent 4639 34e6d141c227
child 4641 7b5db4e35985
document how a GlobalValue can be set from the command-line and with an environment variable
src/core/global-value.h
     1.1 --- a/src/core/global-value.h	Thu Jul 02 15:13:27 2009 +0200
     1.2 +++ b/src/core/global-value.h	Thu Jul 02 15:32:37 2009 +0200
     1.3 @@ -35,6 +35,14 @@
     1.4   *
     1.5   * Instances of this class are expected to be allocated as static 
     1.6   * global variables and should be used to store configurable global state.
     1.7 + * GlobalValues can be set directly by calling ns3::GlobalValue::SetValue
     1.8 + * but they can also be set through the NS_GLOBAL_VALUE environment variable.
     1.9 + * For example, NS_GLOBAL_VALUE='Name=Value;OtherName=OtherValue;' would set
    1.10 + * global values Name and OtherName to Value and OtherValue respectively. 
    1.11 + *
    1.12 + * Users of the ns3::CommandLine class also get the ability to set global 
    1.13 + * values through commandline arguments to their program: --Name=Value will
    1.14 + * set global value Name to Value.
    1.15   */
    1.16  class GlobalValue
    1.17  {