FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kForwardBlockInfo.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_FORWARD_BLOCK_INFO_H
9 #define K_FIRESYNC_FORWARD_BLOCK_INFO_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 #define kFORWARD_BLOCK_INFO_MAX_PORT_COUNT (64)
16 
17 
23 //typedef kObject kForwardBlockInfo; --forward-declared in kFsDef.x.h
24 
34 
44 kFsFx(kStatus) kForwardBlockInfo_Load(kForwardBlockInfo* info, kXml xml, kAlloc allocator);
45 
55 kFsFx(kStatus) kForwardBlockInfo_Store(kForwardBlockInfo info, kXml* xml, kAlloc allocator);
56 
66 kFsFx(kStatus) kForwardBlockInfo_Read(kForwardBlockInfo info, kXml xml, kXmlItem item);
67 
77 kFsFx(kStatus) kForwardBlockInfo_Write(kForwardBlockInfo info, kXml xml, kXmlItem item);
78 
87 
96 
106 
115 
117 #define kForwardBlockInfo_InputId_(INDEX) (INDEX)
118 
120 #define kForwardBlockInfo_OutputId_(INDEX) (kFORWARD_BLOCK_INFO_MAX_PORT_COUNT + (INDEX))
121 
123 #define kForwardBlockInfo_InputIndex_(ID) (ID)
124 
126 #define kForwardBlockInfo_OutputIndex_(ID) ((ID) - kFORWARD_BLOCK_INFO_MAX_PORT_COUNT)
127 
128 kEndHeader()
129 
130 #include <kFireSync/Blocks/kForwardBlockInfo.x.h>
131 
132 #endif
kStatus kForwardBlockInfo_Clear(kForwardBlockInfo info)
Resets all state variables to default values.
Represents configuration for kForwardBlock.
Essential declarations related to FireSync nodes.
kStatus kForwardBlockInfo_SetPortCount(kForwardBlockInfo info, kSize portCount)
Sets the count of input/output port pairs.
kStatus kForwardBlockInfo_Validate(kForwardBlockInfo info)
Checks and automatically corrects all state variables.
kStatus kForwardBlockInfo_Read(kForwardBlockInfo info, kXml xml, kXmlItem item)
Reads kForwardBlockInfo state from a kXml object.
kStatus kForwardBlockInfo_Store(kForwardBlockInfo info, kXml *xml, kAlloc allocator)
Constructs a kXml object and uses it to store the content of this kForwardBlockInfo instance...
kStatus kForwardBlockInfo_Load(kForwardBlockInfo *info, kXml xml, kAlloc allocator)
Constructs a kForwardBlockInfo object and loads its content from an XML object.
kStatus kForwardBlockInfo_Write(kForwardBlockInfo info, kXml xml, kXmlItem item)
Writes kForwardBlockInfo state to a kXml object.
kSize kForwardBlockInfo_PortCount(kForwardBlockInfo info)
Gets the count of input/output port pairs.
kStatus kForwardBlockInfo_Construct(kForwardBlockInfo *info, kAlloc allocator)
Constructs a kForwardBlockInfo object.