ICapeNumericSTN Class Reference

#include <CapeModel.hpp>

List of all members.

Public Member Functions
virtual void	SetCurrentState (const Common::Types::CapeString &theStateName)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds)
virtual Common::Types::CapeString	GetCurrentState ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder)
virtual ICapeNumericModel *	GetParentModel ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder)
virtual CapeArrayNumericInternalEventInfo	GetPossibleTransitions ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder)
virtual Common::Types::CapeDouble	GetStateTransitions (const Common::Types::CapeString &fromState, CapeArrayNumericEventInfo &eventList, Common::Types::CapeArrayString &stateList)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds)
virtual Common::Types::CapeArrayString	GetStateList ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder)
virtual ICapeNumericModel *	GetStateModel (const Common::Types::CapeString &stateName)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds)
virtual Common::Types::CapeString	MoveToNextState (ICapeNumericEventInfo *firedEvent)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds)

---

Detailed Description

This is the interface which provides facilities for State Transition Networks.

---

Member Function Documentation

virtual Common::Types::CapeString GetCurrentState

(

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) [pure virtual]

Gets the name of the current state for this STN.

virtual ICapeNumericModel* GetParentModel

(

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) [pure virtual]

Gets the model which owns this specific STN.

virtual CapeArrayNumericInternalEventInfo GetPossibleTransitions

(

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) [pure virtual]

Gets the list of all the transitions for the current state in this STN.

virtual Common::Types::CapeArrayString GetStateList

(

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) [pure virtual]

Gets the list of all the states in the STN.

virtual ICapeNumericModel* GetStateModel

(

const Common::Types::CapeString &

stateName

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds) [pure virtual]

Gets the model associated with a particular state.

virtual Common::Types::CapeDouble GetStateTransitions	(	const Common::Types::CapeString &	fromState,
		CapeArrayNumericEventInfo &	eventList,
		Common::Types::CapeArrayString &	stateList
	)		throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds) [pure virtual]

Returns the names of the states which can be reached from a specified state of the network, together with the EventInfos [Events] which control each transition.

Parameters:

fromState	the name of the state
eventList	list of the EventInfos associated to each transition
stateList	list of the corresponding names of the states

virtual Common::Types::CapeString MoveToNextState

(

ICapeNumericEventInfo *

firedEvent

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds) [pure virtual]

Changes the current state according to the event that has fired.

Parameters:

firedEvent

the eventInfo that has triggered the change to a new state

virtual void SetCurrentState

(

const Common::Types::CapeString &

theStateName

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds) [pure virtual]

Sets the value of the current state. This method can be used to set the value of the initial state or internally to switch from one state to another.

Parameters:

theStateName

the name of the current state

---

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

• CapeModel.hpp