Changes between Version 1 and Version 2 of HooksConfiguration


Ignore:
Timestamp:
Oct 7, 2015, 11:28:51 AM (2 years ago)
Author:
stephen
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • HooksConfiguration

    v1 v2  
    6060
    6161'''std::string getStringParameter(const std::string& name)'''[[BR]]
    62 Returns the value of the named parameter as a string.  An exception is thrown if this is not possible (e.g. the value is specified as a JSON structure such as a map).
     62Returns the value of the named parameter as a string.  An exception is thrown if the value is not a string.
    6363
    6464'''long getIntegerParameter(const std::string& name)'''[[BR]]
    65 Returns the value of the named parameter as an integer.  If it is unable to (e.g. the value is is specified as a JSON structure such as a map, or is a string that does not translate to an integer), an exception is thrown.
     65Returns the value of the named parameter as an integer.  An exception is thrown if the value is not an integer.
    6666
    6767'''bool getBooleanParameter(const std::string& name)'''[[BR]]
    68 Returns the value of the named parameter as a boolean value.  An exception is thrown if this is not possible (e.g. the value is specified as a JSON structure such as a map).
     68Returns the value of the named parameter as a boolean value.  An exception is thrown if the value is not boolean.
    6969
    70 (Certain conversion rules will apply, e.g. if the parameter is specified as an integer but is retrieved as a boolean value, false will be returned if the value of the parameter is 0, true otherwise.)
     70QUESTION: is this syntax better than {{{void getParameter(const std::string& name, T& value)}}}?