Skip to content
Snippets Groups Projects
Commit d09c500a authored by Matthew D Jones's avatar Matthew D Jones
Browse files

Re #14178 Updated documentation

parent 66388159
No related branches found
No related tags found
No related merge requests found
......@@ -44,8 +44,8 @@ void AddSampleLog::init() {
typeOptions.push_back("");
declareProperty("NumberType", "",
boost::make_shared<StringListValidator>(typeOptions),
"Force LogText to be interpreted as a number of type \"int\" "
"or \"double\".");
"Force LogText to be interpreted as a number of type 'int' "
"or 'double'.");
}
void AddSampleLog::exec() {
......
......@@ -21,6 +21,11 @@ If the LogText contains a numeric value, the created log will be of
integer type if an integer is passed and floating point (double)
otherwise. This applies to both the Number & Number Series options.
The algorithm can be forced to create a log of integer or floating point
type by using the optional NumberType property as 'Int' or 'Double'. For
example, with NumberType='Double' the log for LogText='12' would be
created as a floating point (double) rather than an integer.
To add logs that vary over time (Time Series Logs) use :ref:`algm-AddTimeSeriesLog`.
Usage
......@@ -60,4 +65,4 @@ Output:
.. categories::
.. sourcelink::
\ No newline at end of file
.. sourcelink::
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment