FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kAxAction.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_AX_ACTION_H
9 #define K_FIRESYNC_AX_ACTION_H
10 
11 #include <kFireSync/kFsDef.h>
12 #include <kFireSync/kNodeDef.h>
13 
14 kBeginHeader()
15 
16 
25 //typedef kObject kAxAction; --forward-declared in kFsDef.x.h
26 
27 
36  kFsFx(const kChar*) kAxAction_Description(kType type);
37 
52 kFsFx(kStatus) kAxAction_Construct(kAxAction* action, kType type, const kChar* name, kActionTrigger trigger, kAxEnviron actionEnviron, kAlloc allocator);
53 
63 kFsFx(kStatus) kAxAction_Validate(kType type, kXml settings, kAlloc alloc);
64 
75 kFsFx(kStatus) kAxAction_Invoke(kAxAction action, kObject input, kObject* output, kAlloc alloc);
76 
84 kFsFx(const kChar*) kAxAction_Name(kAxAction action);
85 
93 kFsFx(kActionTrigger) kAxAction_Trigger(kAxAction action);
94 
104 kFsFx(kXml) kAxAction_Settings(kAxAction action);
105 
120 kFsFx(kNode) kAxAction_Node(kAxAction action);
121 
129 kFsFx(kSystem) kAxAction_System(kAxAction action);
130 
131 kEndHeader()
132 
133 #include <kFireSync/Action/kAxAction.x.h>
134 
135 #endif
kAxAction
Abstract base class for action implementations.
kAxAction::kAxAction_Trigger
kActionTrigger kAxAction_Trigger(kAxAction action)
Gets the action trigger source.
kAxAction::kAxAction_Invoke
kStatus kAxAction_Invoke(kAxAction action, kObject input, kObject *output, kAlloc alloc)
Virtual method that can be overridden to perform custom processing when action is invoked...
kAxAction::kAxAction_System
kSystem kAxAction_System(kAxAction action)
Gets a reference to a kSystem object representing the collection of discovered nodes.
kAxAction::kAxAction_Settings
kXml kAxAction_Settings(kAxAction action)
Returns the action's settings.
kActionTrigger
Represents an action trigger type.
kNodeDef.h
Essential declarations related to FireSync nodes.
kNode
Represents a FireSync node (sensor).
kFsDef.h
Essential API declarations for the kFireSync library.
kAxAction::kAxAction_Validate
kStatus kAxAction_Validate(kType type, kXml settings, kAlloc alloc)
Virtual method that can be overridden to perform XML settings validation.
kAxAction::kAxAction_Description
const kChar * kAxAction_Description(kType type)
Given a kAxAction subclass type, gets a description of the class.
kSystem
Represents a collection of FireSync nodes (sensors).
kAxEnviron
Represents an object that provides external services to an activity object.
kAxAction::kAxAction_Construct
kStatus kAxAction_Construct(kAxAction *action, kType type, const kChar *name, kActionTrigger trigger, kAxEnviron actionEnviron, kAlloc allocator)
Factory constructor for action objects.
kAxAction::kAxAction_Name
const kChar * kAxAction_Name(kAxAction action)
Gets a descriptive name for the action instance.
kAxAction::kAxAction_Node
kNode kAxAction_Node(kAxAction action)
Gets a reference to a kNode object representing the local node.