LogOperator Class
(Automation::LogOperator)The LogOperator calculates the logarithm of the input value to base 10. More...
Header: | #include <LogOperator.h> |
Inherits: | CDPOperator<T> |
Public Functions
LogOperator(const CDPPropertyBase &in) |
Reimplemented Public Functions
virtual unsigned int | Process() override |
- 18 public functions inherited from CDPOperator
- 17 public functions inherited from CDPOperatorBase
- 46 public functions inherited from CDPBaseObject
- 26 public functions inherited from CDP::StudioAPI::CDPNode
- 22 public functions inherited from CDP::StudioAPI::ICDPNode
Additional Inherited Members
- 1 public variable inherited from CDPOperatorBase
- 1 static public member inherited from CDPBaseObject
- 1 protected function inherited from CDP::StudioAPI::CDPNode
- 8 protected variables inherited from CDPOperator
- 5 protected variables inherited from CDPOperatorBase
- 11 protected variables inherited from CDPBaseObject
Detailed Description
The LogOperator calculates the logarithm of the input value to base 10.
The input value must be greater than 0, otherwise the output will be set to NaN (Not-A-Number) and operator processing status will be set to STATUS_ERROR.
Arguments
Name | Description |
---|---|
In | The default input value. |
Out | The default output value. |
When operator is used inside a signal its default input is automatically tied to signal's InternalValue or previous operator's output. Its default output is automatically tied to next operator's input or to signal's Value. See also CDP Operator Usage In CDP Signals.
Example
Below is an example plot with linearly increasing signal (cyan) and the same signal with LogOperator() applied (orange):
Actual Processing Code of the LogOperator
unsigned int LogOperator<double>::Process() { double out = log10((double)m_input); m_output = out; return std::isnan(out)? STATUS_ERROR : STATUS_OK; }
See also Argument.
Member Function Documentation
LogOperator::LogOperator(const CDPPropertyBase &in)
Default constructs an instance of LogOperator.
[override virtual]
unsigned int LogOperator::Process()
Get started with CDP Studio today
Let us help you take your great ideas and turn them into the products your customer will love.