#include <CapeModel.hpp>
Public Member Functions | |
| virtual CapeEventInfoKind | QueryKind ()=0 throw (Common::Error::ECapeUnknown) |
| virtual ICapeNumericEvent * | GetSubEvent ()=0 throw (Common::Error::ECapeUnknown) |
| virtual ICapeNumericEvent * | GetEvent ()=0 throw (Common::Error::ECapeUnknown) |
Detailed Description
This is the interface for handling information on events. This object is designed as a return value from the DAESolver object, and contains information about the occurence of an Event. The EventInfo object itself contains only a method to indicate the kind of event information returned (external or internal), and another to access the "sub Event" object: this is so called because even when a transition or stopping condition is specified with a composite event, the Solver is expected to return the most detailed information it can. This is likely to be a component of the original composite event. Further detail is dependent on the kind of event information, and is contained in two distinct subtypes derived from it. An enumerated type is needed to define the kind, as follows:
CapeEventInfoKind = {INTERNAL, EXTERNAL}
Member Function Documentation
| virtual ICapeNumericEvent* GetEvent | ( | ) | throw (Common::Error::ECapeUnknown) [pure virtual] |
Gets the event associated with this Event Info.
| virtual ICapeNumericEvent* GetSubEvent | ( | ) | throw (Common::Error::ECapeUnknown) [pure virtual] |
Provides access to the sub-event object.
| virtual CapeEventInfoKind QueryKind | ( | ) | throw (Common::Error::ECapeUnknown) [pure virtual] |
Returns the kind of EventInfo.
The documentation for this class was generated from the following file:
