ACT::ACT_State Class Reference

Generically state of an ACT as a scheduler and other actions see it. More...

#include <ACT.hpp>

List of all members.

Public Types
enum	state { Ready, Would_Block, Completed, Bad }
	Symbolic names for the return states of an action. More...
Public Member Functions
	ACT_State (state x)
	Ordinary constructor.
ACT_State &	operator= (state y)
	Ordinary assignment.
bool	ready () const
	Convenience test.
bool	would_block () const
	Convenience test.
bool	completed () const
	Convenience test.
bool	bad () const
	Convenience test.
bool	working () const

---

Detailed Description

Generically state of an ACT as a scheduler and other actions see it.

This enumeration is at the core of the control flow idiom of the ACT environment. When a scheduler or another action calls an action, the action may complete its call before it completes its embodied operation. The states break down as follows:

• Action is not finished. In this case, the operation is not yet finished and is still working. Further calls to this action will be necessary to get to a finished state, which will not happen autonomously. This state comes in two varieties.
  • Ready. The action spontaneously yielded control. An immediate call to this action would immediately continue.
  • Would_Block. The action returned because it would block otherwise. An immediate call to this action is unlikely to do anything else.
• Action has finished. One way or another, this action has finished its processing. Further calls to this action do nothing.
  • Completed. The action has finished and its ordinary postconditions may be relied upon.
  • Bad. The action has entered an abnormal state and its ordinary postconditions need not be true. As a rule, actions in this state terminated early.

An important aspect of the Waiting state is that an action that returns this state has accepted responsibility for setting in motion its own later wake-up. The scheduler does not do this, since it doesn't deal in specifics.

---

Member Enumeration Documentation

enum ACT::ACT_State::state

Symbolic names for the return states of an action.

Enumerator:

Ready	Not finished. Ready to continue immediately.
Would_Block	Not finished. Presumed not ready.
Completed	Finished normally.
Bad	Abnormal termination; now finished.

---

Constructor & Destructor Documentation

ACT::ACT_State::ACT_State

(

state

x

)

[inline]

Ordinary constructor.

---

Member Function Documentation

ACT_State& ACT::ACT_State::operator=

(

state

y

)

[inline]

Ordinary assignment.

bool ACT::ACT_State::ready

(

)

const [inline]

Convenience test.

bool ACT::ACT_State::would_block

(

)

const [inline]

Convenience test.

bool ACT::ACT_State::completed

(

)

const [inline]

Convenience test.

bool ACT::ACT_State::bad

(

)

const [inline]

Convenience test.

bool ACT::ACT_State::working

(

)

const [inline]

Test whether state is an unfinished (i.e. still working) state. If true, it's either Ready or Waiting.

---

The documentation for this class was generated from the following file:

• ACT.hpp

---