Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

baci::BACIAction Class Reference

#include <baciBACIAction.h>

Collaboration diagram for baci::BACIAction:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BACIAction ()
 BACIAction (ActionImplementator *actionImplementator_, int actionFunction_, int callbackID_)
 BACIAction (ActionImplementator *actionImplementator_, int actionFunction_, int callbackID_, const BACIValue &value_)
BACIActionoperator= (const BACIAction &action)
bool operator== (const BACIAction &action) const
ActionRequest invoke (BACIComponent *component_p, int callbackID_, const CBDescIn &descIn, BACIValue *value, Completion &completion, CBDescOut &descOut)
int getActionFunction () const
ActionImplementatorgetActionImplementator () const
int getCallbackID () const
BACIValue getValue () const
BACIValuegetValueRef () const
bool isCompleted () const
Completion getCompletion () const
void setCompletion (const Completion &c)

Private Member Functions

 BACIAction (const BACIAction &)

Private Attributes

int actionFunction_m
ActionImplementatoractionImplementator_mp
int callbackID_m
BACIValue value_m
bool completed_m
Completion completion_m

Detailed Description

Class representing BACI Action Since all BACI asynchronious class has to keep all needed data to invoke action in the future...
Author:
Matej Sekoranja, Jozef Stefan Institute, Slovenia


Constructor & Destructor Documentation

baci::BACIAction::BACIAction  )  [inline]
 

Null contructor

baci::BACIAction::BACIAction ActionImplementator actionImplementator_,
int  actionFunction_,
int  callbackID_
[inline]
 

Null value constructor

Parameters:
actionFunction_ action function to be invoked in execute action
callbackID_ id of the callback to be invoked

baci::BACIAction::BACIAction ActionImplementator actionImplementator_,
int  actionFunction_,
int  callbackID_,
const BACIValue value_
[inline]
 

Constructor

Parameters:
actionImplemenator_ action implementator
actionFunction_ action function to be invoked in execute action
callbackID_ id of the callback to be invoked
value_ action data (e.g. value to be set)

baci::BACIAction::BACIAction const BACIAction  )  [private]
 

ALMA C++ coding standards state copy constructors should be disabled.


Member Function Documentation

int baci::BACIAction::getActionFunction  )  const [inline]
 

Get BACI Action Function

Returns:
action function

ActionImplementator* baci::BACIAction::getActionImplementator  )  const [inline]
 

Get BACI Action Implementator

Returns:
action implementator

int baci::BACIAction::getCallbackID  )  const [inline]
 

Get callback ID

Returns:
callback ID

Completion baci::BACIAction::getCompletion  )  const [inline]
 

Get completion data

Returns:
completion data

BACIValue baci::BACIAction::getValue  )  const [inline]
 

Get action data

Returns:
action data (e.g. value to be set)

BACIValue* baci::BACIAction::getValueRef  )  const [inline]
 

Get reference to action data

Returns:
action data (e.g. value to be set)

ActionRequest baci::BACIAction::invoke BACIComponent component_p,
int  callbackID_,
const CBDescIn descIn,
BACIValue value,
Completion completion,
CBDescOut descOut
[inline]
 

Invoke action

Parameters:
component_p owner of the action
callbackID id of the callback to be notified
descIn callback descriptor (passed by client)
value action data (e.g. value to be set)
completion error handing structure
descOut callback descriptor which will be passed to client
Returns:
request to be performed by BACI

bool baci::BACIAction::isCompleted  )  const [inline]
 

Get completion state

Returns:
completion state

BACIAction& baci::BACIAction::operator= const BACIAction action  )  [inline]
 

Assignment operator

bool baci::BACIAction::operator== const BACIAction action  )  const [inline]
 

Compare (equals) operator

void baci::BACIAction::setCompletion const Completion c  )  [inline]
 

Set completion state to true


Member Data Documentation

int baci::BACIAction::actionFunction_m [private]
 

BACI Action Function

ActionImplementator* baci::BACIAction::actionImplementator_mp [private]
 

BACI Action Implementator

int baci::BACIAction::callbackID_m [private]
 

Callback ID

bool baci::BACIAction::completed_m [private]
 

Completion state

Completion baci::BACIAction::completion_m [private]
 

Completion data

BACIValue baci::BACIAction::value_m [private]
 

Action data (e.g. value to be set)


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 02:37:10 2009 for ACS C++ API by doxygen 1.3.8