FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kTimerBlockInfo.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_TIMER_BLOCK_INFO_H
9 #define K_FIRESYNC_TIMER_BLOCK_INFO_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
19 //typedef kObject kTimerBlockInfo; --forward-declared in kFsDef.x.h
20 
29  kFsFx(kStatus) kTimerBlockInfo_Construct(kTimerBlockInfo* info, kAlloc allocator);
30 
40 kFsFx(kStatus) kTimerBlockInfo_Load(kTimerBlockInfo* info, kXml xml, kAlloc allocator);
41 
51 kFsFx(kStatus) kTimerBlockInfo_Store(kTimerBlockInfo info, kXml* xml, kAlloc allocator);
52 
62 kFsFx(kStatus) kTimerBlockInfo_Read(kTimerBlockInfo info, kXml xml, kXmlItem item);
63 
73 kFsFx(kStatus) kTimerBlockInfo_Write(kTimerBlockInfo info, kXml xml, kXmlItem item);
74 
82 kFsFx(kStatus) kTimerBlockInfo_Validate(kTimerBlockInfo info);
83 
91 kFsFx(kStatus) kTimerBlockInfo_Clear(kTimerBlockInfo info);
92 
101 kFsFx(kStatus) kTimerBlockInfo_SetPeriod(kTimerBlockInfo info, k64u period);
102 
110 kFsFx(k64u) kTimerBlockInfo_Period(kTimerBlockInfo info);
111 
113 kInlineFx(k16u) kTimerBlockInfo_OutputId() { return (k16u) 0; }
114 
115 #include <kFireSync/Blocks/kTimerBlockInfo.x.h>
116 
117 #endif
kTimerBlockInfo::kTimerBlockInfo_SetPeriod
kStatus kTimerBlockInfo_SetPeriod(kTimerBlockInfo info, k64u period)
Sets the timer period.
kTimerBlockInfo::kTimerBlockInfo_Load
kStatus kTimerBlockInfo_Load(kTimerBlockInfo *info, kXml xml, kAlloc allocator)
Constructs a kTimerBlockInfo object and loads its content from an XML object.
kTimerBlockInfo_OutputId
k16u kTimerBlockInfo_OutputId()
Gets the output port id for this block type.
Definition: kTimerBlockInfo.h:113
kTimerBlockInfo
Represents configuration for kTimerBlock.
kNodeDef.h
Essential declarations related to FireSync nodes.
kTimerBlockInfo::kTimerBlockInfo_Read
kStatus kTimerBlockInfo_Read(kTimerBlockInfo info, kXml xml, kXmlItem item)
Reads kTimerBlockInfo state from a kXml object.
kTimerBlockInfo::kTimerBlockInfo_Write
kStatus kTimerBlockInfo_Write(kTimerBlockInfo info, kXml xml, kXmlItem item)
Writes kTimerBlockInfo state to a kXml object.
kTimerBlockInfo::kTimerBlockInfo_Construct
kStatus kTimerBlockInfo_Construct(kTimerBlockInfo *info, kAlloc allocator)
Constructs a kTimerBlockInfo object.
kTimerBlockInfo::kTimerBlockInfo_Clear
kStatus kTimerBlockInfo_Clear(kTimerBlockInfo info)
Resets all state variables to default values.
kTimerBlockInfo::kTimerBlockInfo_Period
k64u kTimerBlockInfo_Period(kTimerBlockInfo info)
Gets the timer period.
kTimerBlockInfo::kTimerBlockInfo_Validate
kStatus kTimerBlockInfo_Validate(kTimerBlockInfo info)
Checks and automatically corrects all state variables.
kTimerBlockInfo::kTimerBlockInfo_Store
kStatus kTimerBlockInfo_Store(kTimerBlockInfo info, kXml *xml, kAlloc allocator)
Constructs a kXml object and uses it to store the content of this kTimerBlockInfo instance...