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 #define kFORWARD_BLOCK_INFO_MAX_PORT_COUNT (64)
14 
15 
21 //typedef kObject kForwardBlockInfo; --forward-declared in kFsDef.x.h
22 
32 
42 kFsFx(kStatus) kForwardBlockInfo_Load(kForwardBlockInfo* info, kXml xml, kAlloc allocator);
43 
53 kFsFx(kStatus) kForwardBlockInfo_Store(kForwardBlockInfo info, kXml* xml, kAlloc allocator);
54 
64 kFsFx(kStatus) kForwardBlockInfo_Read(kForwardBlockInfo info, kXml xml, kXmlItem item);
65 
75 kFsFx(kStatus) kForwardBlockInfo_Write(kForwardBlockInfo info, kXml xml, kXmlItem item);
76 
85 
94 
104 
113 
115 kInlineFx(k16u) kForwardBlockInfo_InputId(kSize index) { return (k16u) index; }
116 
119 
122 
125 
126 #include <kFireSync/Blocks/kForwardBlockInfo.x.h>
127 
128 #endif
k16u kForwardBlockInfo_OutputId(kSize index)
Gets the output port id associated with the specified input/output pair index.
Definition: kForwardBlockInfo.h:118
kStatus kForwardBlockInfo_Clear(kForwardBlockInfo info)
Resets all state variables to default values.
Represents configuration for kForwardBlock.
#define kFORWARD_BLOCK_INFO_MAX_PORT_COUNT
Maximum supported channels.
Definition: kForwardBlockInfo.h:13
#define kInlineFx(TYPE)
Essential declarations related to FireSync nodes.
k16u kForwardBlockInfo_InputId(kSize index)
Gets the input port id associated with the specified input/output pair index.
Definition: kForwardBlockInfo.h:115
kStatus kForwardBlockInfo_SetPortCount(kForwardBlockInfo info, kSize portCount)
Sets the count of input/output port pairs.
kSize kForwardBlockInfo_OutputIndex(k32u id)
Gets the input/output pair index associated with the specified output port id.
Definition: kForwardBlockInfo.h:124
kStatus kForwardBlockInfo_Validate(kForwardBlockInfo info)
Checks and automatically corrects all state variables.
kSize kForwardBlockInfo_InputIndex(k32u id)
Gets the input/output pair index associated with the specified input port id.
Definition: kForwardBlockInfo.h:121
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.