FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kBlock Class Reference

Description

Represents block configuration.

Inheritance diagram for kBlock:
Inheritance graph

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 kCharkBlock_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 kCharkBlock_TypeName (kBlock block)
 Gets the type name of this block. More...
 

Related

#define kBLOCK_SETTINGS_ROOT_NAME
 Required XML root name for block settings.
 
#define kBLOCK_ID_USER_BASE
 Minimum valid identifier for a user-defined block.
 
#define kBLOCK_ID_USER_MAX
 Maximum valid identifier for a user-defined block.
 
#define kBLOCK_ID_SYSTEM_BASE
 Minimum valid identifier for a system-defined block.
 
#define kBLOCK_ID_CAMERA_BASE
 Start of identifier range for camera blocks.
 
#define kBLOCK_ID_NET_OUT
 Unique identifier for the Net Out block.
 
#define kBLOCK_ID_NET_IN
 Unique identifier for the Net In block.
 
#define kBLOCK_ID_LIGHT_BASE
 Start of identifier range for light blocks.
 
#define kBLOCK_ID_TIMER
 Start of identifier range for timer blocks.
 
k16u kBlockId_Camera (kSize id)
 Returns the block identifer for a given camera id.
 
k16u kBlockId_Light (kSize id)
 Returns the block identifer for a given light id.
 
k16u kBlockId_NetOut ()
 Returns the block identifer for the Net Out block.
 
k16u kBlockId_NetIn ()
 Returns the block identifer for the Net In block.
 
k16u kBlockId_Timer ()
 Returns the block identifer for the timer block.
 
#define kPORT_ID_CAMERA_STATE_BASE
 Start of identifier range for camera state ports.
 
#define kPORT_ID_CAMERA_VIDEO_BASE
 Start of identifier range for camera video ports.
 
#define kPORT_ID_CAMERA_ALGORITHM_BASE
 Start of identifier range for camera algorithm ports.
 
#define kPORT_ID_CAMERA_STRIPE_BASE
 Start of identifier range for camera stripe ports.
 
#define kPORT_ID_CAMERA_PHASE_BASE
 Start of identifier range for camera phase ports.
 
#define kPORT_ID_CAMERA_INPUT_BASE
 Start of identifier range for camera input ports.
 
k16u kPortId_CameraState (kSize id)
 Returns the camera state port identifer for a given state id. More...
 
k16u kPortId_CameraVideo (kSize id)
 Returns the camera video port identifer for a given state id. More...
 
k16u kPortId_CameraAlgorithm (kSize id)
 Returns the camera algorithm port identifer for a given state id. More...
 
k16u kPortId_CameraStripe ()
 Returns the camera stripe port identifer for a given state id. More...
 
k16u kPortId_CameraPhase ()
 Returns the camera phase port identifer for a given state id. More...
 
k16u kPortId_CameraOverride ()
 Returns the camera override input port identifer. More...
 
k16u kPortId_CameraCalibration ()
 Returns the camera calibration input port identifer. More...
 
k16u kPortId_CameraDynFpn ()
 Returns the camera dynamic FPN input port identifer. More...
 

The documentation for this class was generated from the following files: