AddRandom Class
(Automation::AddRandom)A Random value adder operator. More...
Header: | #include <AddRandom.h> |
Inherits: | CDPOperator<T> |
Public Functions
AddRandom(const CDPPropertyBase &in) | |
virtual | ~AddRandom() |
Reimplemented Public Functions
- 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
A Random value adder operator.
This CDP operator can be used to add a uniformly distributed random number to output. This can be useful to imitate input signal noise in test systems (for example Sine+Random).
F.e. AddRandom with arguments Lower=-1.0 and Upper=1.0 will add random number between -1...1 to signal at every calculation cycle.
Arguments
Name | Description |
---|---|
In | The default input value. |
Out | The default output value. |
Lower | Random generator lower limit. |
Upper | Random generator upper limit. |
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.
Lower and Upper argument can be routed from another signal, parameter or property.
Example
Below is example plot with Sine signal (cyan) and the same signal with operator AddRandom(Lower=-0.1, Upper=0.1) applied (orange):
Actual Processing Code of the AddRandom
unsigned int AddRandom<T>::Process() { if (!d->lower || !d->upper) return STATUS_SIGNAL_FAULT; std::uniform_real_distribution<double>unif(static_cast<T>(*d->lower), static_cast<T>(*d->upper)); T random = unif(d->re); m_output = static_cast<T>(m_input) + random; return STATUS_OK; }
See also Argument.
Member Function Documentation
AddRandom::AddRandom(const CDPPropertyBase &in)
Constructs a AddRandom with input in.
[virtual]
AddRandom::~AddRandom()
Destructs the AddRandom operator
[override virtual]
void AddRandom::Configure(XMLPrimitive *operatorXML)
Reimplemented from CDPBaseObject::Configure().
[override virtual]
unsigned int AddRandom::Process()
Reimplemented from CDPOperatorBase::Process().
Returns STATUS_OK.
Get started with CDP Studio today
Let us help you take your great ideas and turn them into the products your customer will love.