Member Function Documentation

CDPEngine::~CDPEngine()

CDPEngine destructor, deallocates memory and cleans up.

[override virtual] void CDPEngine::Activate()

Reimplemented from CDPBaseObject::Activate().

Activates CDPEngine

[virtual] void CDPEngine::ActivateWaitingForActivateComponents()

Activates all objects that should be activated at t=nowTime.

[virtual] void CDPEngine::AddActivateWait(CDPObject *object)

Adds an object for delayed activation

void CDPEngine::AddAlias(unsigned int handle, const std::string &alias)

Adds or override global short alias name to point to the handle.

void CDPEngine::AddSafeCallRequest(uintptr_t requester, ICDPNode *target, const std::function<void() > &callback)

[virtual] int CDPEngine::ClearSuspendAlarm(CDPComponent *component)

Clears a suspend alarm.

[override virtual] void CDPEngine::Configure(const char *xml)

void CDPEngine::Connect(CDPBaseObject *object)

Adds a CDPBaseObject to the CDPEngine

void CDPEngine::ConnectProcess(CDPSchedulable *item)

Adds a component to the scheduler priority specified in processMode

Must be called in the item's context.

[override virtual] void CDPEngine::Create(const char *name)

Reimplemented from CDPComponent::Create().

Creates objects owned by CDPEngine.

double CDPEngine::GetCDPmsgTimeLimitProcMsg()

Returns the timeLimit for message processing.

CDPObject *CDPEngine::GetComponent(unsigned int handle)

Obsolete: changed name to GetObject(), use that one instead.

std::string CDPEngine::GetComponentName(unsigned int handle)

Returns the component name from a valid handle, or empty string if not found.

std::string CDPEngine::GetComponentType(unsigned int handle)

Returns the component type (model) from a valid handle, or empty string if not found.

[static] CDPEngine *CDPEngine::GetInstance()

Returns the only CDPEngine instance

CDPBaseObject *CDPEngine::GetObject(unsigned int handle)

Returns pointer to CDPBaseObject or CDPObject at index handle

CDPBaseObject *CDPEngine::GetObject(const std::string &longName)

Returns pointer to CDPBaseObject or CDPObject with registered Handle

std::string CDPEngine::GetObjectName(unsigned int handle)

Returns the object name from a valid handle, or empty string if not found.

std::string CDPEngine::GetObjectName(CDPBaseObject *pObj)

Returns the object name from a pointer, or empty string if nullptr

std::string CDPEngine::GetObjectType(unsigned int handle)

Returns the object type (model) from a valid handle, or empty string if not found

std::string CDPEngine::GetObjectType(CDPBaseObject *pObj)

Returns the object type from a pointer , or empty string if nullptr

CDPProcess *CDPEngine::GetProcess(CDPSchedulable *item)

CDPThreadPool *CDPEngine::GetWorkerPool()

Returns CDPThreadPool that contains CDPEngine configured number of workers with set stack size and priority Returns nullptr before CDPEngine::Configure().

unsigned int CDPEngine::LastComponent()

Returns the index of the last component

See also LastObject.

unsigned int CDPEngine::LastObject()

Returns the index of the last object

[override virtual] void CDPEngine::ProcessNull()

Reimplemented from CDPComponent::ProcessNull().

Sets overload alarms and component suspended alarms

[virtual] void CDPEngine::RemoveActivateWait(CDPObject *object)

Removes an object from delayed activation

void CDPEngine::RemoveAlias(const std::string &alias)

Removea global alias name form engine.

void CDPEngine::RemoveObject(unsigned int handle, CDPBaseObject *object)

Removes component object from engine, verifies that handle matches object pointer.

void CDPEngine::SafeCallRequesterExpired(uintptr_t requester, bool discardWork = false)

The SafeCallRequesterExpired method must be called after requester is no longer interested in adding more safe calls.

discardWork can optionally be passed to discard all work in the queues for the given requester. When work is not discarded it is the responsibility of the requester to make sure the provided callback is safe to use after SafeCallRequesterExpired has been called.

This function is thread-safe.

void CDPEngine::SendNotify(MessageRequestHandle *message)

Invokes SendNotify function in the object that the message is for.

[virtual] int CDPEngine::SetSuspendAlarm(CDPComponent *component, std::string &descr)

Sets a suspend alarm

void CDPEngine::StopThreads()

Stops the low, normal and high priority schedulers