Member Function Documentation

CDPOperatorBase::CDPOperatorBase(const CDPPropertyBase &in, Argument<T> *arg)

Default constructs an instance of CDPOperatorBase.

[virtual] CDPOperatorBase::~CDPOperatorBase()

Destructs the CDPOperatorBase.

[pure virtual] void CDPOperatorBase::Create(const char *shortName, CDPBaseObject *parent)

Reimplemented from CDPBaseObject::Create().

Creates the operator, sets shortName and parent.

[pure virtual] void CDPOperatorBase::ForEachArgument(const std::function<void( ArgumentBase & ) > f)

Call argument f function for each Argument (arguments in m_arguments, m_inArg and m_outArg) the CDPOperator has.

OSAPIMutex &CDPOperatorBase::GetMemberAccessMutex()

[pure virtual] const std::string &CDPOperatorBase::GetName()

Returns the name of the operator

double CDPOperatorBase::GetOperatorPeriod() const

Returns GetParent()->GetOperatorPeriod(), which usually corresponds to CDPComponent's GetPeriod(), but may return other value in overridden function.

[pure virtual] const CDPPropertyBase &CDPOperatorBase::GetOutput()

Returns the output property.

double CDPOperatorBase::GetPeriod() const

Returns GetParent()->GetPeriod().

std::string CDPOperatorBase::GetPriorityName() const

CDPProcess *CDPOperatorBase::GetProcess() const

std::string CDPOperatorBase::GetSchedulingGroupName() const

int CDPOperatorBase::GetSyncInId()

int CDPOperatorBase::GetSyncOutId()

[virtual] void CDPOperatorBase::Init()

Does nothing, but may be overrided for some CDPOperators. The purpose of the function is to (re)initialize some internal queues or variables to start from scratch when something changes. E.g. IIRFilter and RampFilter use Init() to reset history and calculation. Currently, CDPOperatorBase::Init() is called when the (scheduling)frequency has changed for the owner CDPComponent.

bool CDPOperatorBase::NeedsSync()

[pure virtual] void CDPOperatorBase::Pass()

Called when signal operators are disabled. Should be used to pass input property value to output.

[pure virtual] unsigned int CDPOperatorBase::Process()

This is the process function that implements the signal processing from input to output.

It returns an 'unsigned int' status as defined in CDPAlarm/AlarmStatusDefines.h, or STATUS_OK if status is not modified by the operator. The returned status is or'ed into the owning signal status, to allow a 'worst' status aggregation accessible in the signal.

void CDPOperatorBase::SetProcess(CDPProcess *process)