Plugins

Covers Engine Plugin SDK 2.0.0 · Interface Plugin SDK 0.2.0

Channels

Read and modify channel definitions, values, fields, and history through the Engine SDK.

DeclarationDescription
ChannelFieldAddressable fields stored for each RAPID channel.
ChannelValueValue types accepted by channel read, write, and authority APIs.
SDK_API::createFixedChannelCreates a channel in fixed RAPID storage, or promotes an existing dynamic channel.
FixedChannelHandleStable retained address of a fixed RAPID channel.
SDK_API::insertChannelFieldCreates a missing channel with an initial field value; an existing channel is left unchanged.
SDK_API::queryChannelReads the current numeric value from a retained local fixed-channel handle.
SDK_API::queryChannelFieldReads a typed field and returns the supplied default when the field is unavailable.
RecordModeControls when channel values are recorded to persistence.
SDK_API::removeChannelRemoves a channel and its associated field data.
SDK_API::upsertChannelAttempts an immediate numeric write without claiming authority.
SDK_API::upsertChannelFieldCreates or replaces a field on a RAPID channel.
SDK_API::upsertChannelValueBulkWrites timestamped numeric samples to one channel in a single call.