FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kInvertBlockInfo.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_INVERT_BLOCK_INFO_H
9 #define K_FIRESYNC_INVERT_BLOCK_INFO_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
20 
22 #define kINVERT_BLOCK_ALGORITHM_HOST (0x1)
23 #define kINVERT_BLOCK_ALGORITHM_CUDA (0x2)
24 
32 typedef k32s kInvertBlockMemory;
33 
35 #define kINVERT_BLOCK_MEMORY_HOST (0x1)
36 #define kINVERT_BLOCK_MEMORY_CUDA (0x2)
37 #define kINVERT_BLOCK_MEMORY_CUDA_DEVICE (0x4)
38 #define kINVERT_BLOCK_MEMORY_CUDA_MANAGED (0x8)
39 
41 #include <kFireSync/Blocks/kInvertBlockInfo.x.h>
42 
49 //typedef kObject kInvertBlockInfo; --forward-declared in kFsDef.x.h
50 
60 
70 kFsFx(kStatus) kInvertBlockInfo_Load(kInvertBlockInfo* info, kXml xml, kAlloc allocator);
71 
81 kFsFx(kStatus) kInvertBlockInfo_Store(kInvertBlockInfo info, kXml* xml, kAlloc allocator);
82 
92 kFsFx(kStatus) kInvertBlockInfo_Read(kInvertBlockInfo info, kXml xml, kXmlItem item);
93 
103 kFsFx(kStatus) kInvertBlockInfo_Write(kInvertBlockInfo info, kXml xml, kXmlItem item);
104 
113 
122 
132 {
133  kObj(kInvertBlockInfo, info);
134 
135  obj->enabled = enabled;
136 
137  return kOK;
138 }
139 
148 {
149  kObj(kInvertBlockInfo, info);
150 
151  return obj->enabled;
152 }
153 
163 {
164  kObj(kInvertBlockInfo, info);
165 
166  obj->algorithm = algorithm;
167 
168  return kOK;
169 }
170 
179 {
180  kObj(kInvertBlockInfo, info);
181 
182  return obj->algorithm;
183 }
184 
196 {
197  kObj(kInvertBlockInfo, info);
198 
199  obj->memory = memory;
200 
201  return kOK;
202 }
203 
212 {
213  kObj(kInvertBlockInfo, info);
214 
215  return obj->memory;
216 }
217 
220 
223 
224 #endif
kStatus kInvertBlockInfo_Enable(kInvertBlockInfo info, kBool enabled)
Enables the block.
Definition: kInvertBlockInfo.h:131
kStatus kInvertBlockInfo_Write(kInvertBlockInfo info, kXml xml, kXmlItem item)
Writes kInvertBlockInfo state to a kXml object.
kStatus kInvertBlockInfo_Store(kInvertBlockInfo info, kXml *xml, kAlloc allocator)
Constructs a kXml object and uses it to store the content of this kInvertBlockInfo instance...
Represents a kInvertBlock algorithm type.
#define kInlineFx(TYPE)
kStatus kInvertBlockInfo_Construct(kInvertBlockInfo *info, kAlloc allocator)
Constructs a kInvertBlockInfo object.
Essential declarations related to FireSync nodes.
kStatus kInvertBlockInfo_Clear(kInvertBlockInfo info)
Resets all state variables to default values.
kStatus kInvertBlockInfo_Validate(kInvertBlockInfo info)
Checks and automatically corrects all state variables.
k16u kInvertBlockInfo_InputPortId()
Gets the input port id.
Definition: kInvertBlockInfo.h:219
Represents a kInvertBlock memory type.
#define kObj(TypeName_T, T_object)
kBool kInvertBlockInfo_IsEnabled(kInvertBlockInfo info)
Reports whether the block is enabled.
Definition: kInvertBlockInfo.h:147
k16u kInvertBlockInfo_OutputPortId()
Gets the output port id.
Definition: kInvertBlockInfo.h:222
kStatus kInvertBlockInfo_SetOutputMemory(kInvertBlockInfo info, kInvertBlockMemory memory)
Sets the output memory type.
Definition: kInvertBlockInfo.h:195
kStatus kInvertBlockInfo_Read(kInvertBlockInfo info, kXml xml, kXmlItem item)
Reads kInvertBlockInfo state from a kXml object.
Represents configuration for kInvertBlock.
#define kOK
kInvertBlockMemory kInvertBlockInfo_OutputMemory(kInvertBlockInfo info)
Reports the selected output memory type.
Definition: kInvertBlockInfo.h:211
kStatus kInvertBlockInfo_Load(kInvertBlockInfo *info, kXml xml, kAlloc allocator)
Constructs a kInvertBlockInfo object and loads its content from an XML object.
kInvertBlockAlgorithm kInvertBlockInfo_Algorithm(kInvertBlockInfo info)
Reports the selected algorithm implementation.
Definition: kInvertBlockInfo.h:178
kStatus kInvertBlockInfo_SetAlgorithm(kInvertBlockInfo info, kInvertBlockAlgorithm algorithm)
Sets the algorithm implementation that should be used.
Definition: kInvertBlockInfo.h:162