|
FireSync API
|
Represents block configuration.
Public Member Functions | |
| kStatus | kBlock_AssignGroup (kBlock block, k32u groupId) |
| Assigns this block to a processing group. More... | |
| kStatus | kBlock_Config (kBlock block, kXml settings) |
| Gets configuration for the block. More... | |
| kStatus | kBlock_FindPortById (kBlock block, k32u id, kPort *port) |
| Gets the port at the specified index. More... | |
| k32u | kBlock_GroupId (kBlock block) |
| Gets the processing group id associated with this block. More... | |
| k32u | kBlock_Id (kBlock block) |
| Gets the unique identifier for this block. More... | |
| kStatus | kBlock_IdInfo (kBlock block, kInfo32u *info) |
| Reports constraint and validity information for the Id setting. More... | |
| kBool | kBlock_IsGrouped (kBlock block) |
| Reports whether this block has been assigned to a group. More... | |
| const kChar * | kBlock_Name (kBlock block) |
| Gets a descriptive name for this block. More... | |
| kPort | kBlock_PortAt (kBlock block, kSize index) |
| Gets the port at the specified index. More... | |
| kSize | kBlock_PortCount (kBlock block) |
| Gets the number of ports belonging to the block. More... | |
| kStatus | kBlock_SetConfig (kBlock block, kXml settings) |
| Sets configuration for the block. More... | |
| kStatus | kBlock_SetId (kBlock block, k32u id) |
| Sets the unique identifier for this block. More... | |
| kStatus | kBlock_SetName (kBlock block, const kChar *name) |
| Sets a descriptive name for the block. More... | |
| const kChar * | kBlock_TypeName (kBlock block) |
| Gets the type name of this block. More... | |
Related | |
| #define | kBLOCK_SETTINGS_ROOT_NAME "Settings" |
| Required XML root name for block settings. | |
| #define | kBLOCK_ID_USER_BASE (0) |
| Minimum valid identifier for a user-defined block. | |
| #define | kBLOCK_ID_USER_MAX (0x7FFF) |
| Maximum valid identifier for a user-defined block. | |
| #define | kBLOCK_ID_SYSTEM_BASE (0x8000) |
| Minimum valid identifier for a system-defined block. | |
| #define | kBLOCK_ID_CAMERA_BASE (0x8000) |
| Start of identifier range for camera blocks. | |
| #define | kBLOCK_ID_NET_OUT (0x9000) |
| Unique identifier for the Net Out block. | |
| #define | kBLOCK_ID_NET_IN (0x9001) |
| Unique identifier for the Net In block. | |
| #define | kBLOCK_ID_LIGHT_BASE (0xA000) |
| Start of identifier range for light blocks. | |
| #define | kBlockId_Camera_(ID) (kBLOCK_ID_CAMERA_BASE + (k32u)(ID)) |
| Returns the block identifer for a given camera id. | |
| #define | kBlockId_Light_(ID) (kBLOCK_ID_LIGHT_BASE + (k32u)(ID)) |
| Returns the block identifer for a given light id. | |
| #define | kBlockId_NetOut_() (kBLOCK_ID_NET_OUT) |
| Returns the block identifer for the Net Out block. | |
| #define | kBlockId_NetIn_() (kBLOCK_ID_NET_IN) |
| Returns the block identifer for the Net In block. | |
