Class: StatusCondition

vortexdds~StatusCondition()

Represents a condition on an Entities 'communication statuses'.

Note that DDS resources and memory consumed by conditions cannot be automatically reclaimed by the NodeJS engine. Conditions are automatically deleted when the parent entity is deleted. Otherwise, when your application is finished with a Condition, you may call Condition.delete() to release these DDS resources.

Constructor

new StatusCondition()

Internal use only. Use Entity.createStatusCondition() instead.

Extends:

Extends

Members

mask :module:vortexdds.StatusMask

the mask 'communication statuses' selected by this condition.

Type:

Methods

delete()

Releases DDS resources associated with the condition.

Once deleted, the condition can no longer be used.

Note that DDS resources and memory consumed by conditions cannot be automatically reclaimed by the NodeJS engine. Conditions are automatically deleted when the parent entity is deleted. Otherwise, when your application is finished with a Condition, you may call this method to release these DDS resources.

Overrides:

enable(mask)

Change the 'communication statuses' monitored by this status condition.

Parameters:
Name Type Description
mask module:vortexdss.StatusMask

a mask of communication status that should trigger this condition.
Throws:

if the mask is invalid with respect to the parent entity

Type
module:vortexdds.DDSError

triggered() → {boolean}

Checks whether the condition is triggered or not.

Overrides:
Returns:
Type
boolean