Public Member Functions | Protected Member Functions | Friends

adevs::Atomic< X > Class Template Reference

#include <adevs_models.h>

Inheritance diagram for adevs::Atomic< X >:
adevs::Devs< X > adevs::DESS< X > adevs::Hybrid< X > adevs::rk4< X > adevs::rk45< X > adevs::rk45_improved< X >

List of all members.

Public Member Functions

 Atomic ()
 The constructor should place the model into its initial state.
virtual void delta_int ()=0
 Internal transition function.
virtual void delta_ext (double e, const Bag< X > &xb)=0
virtual void delta_conf (const Bag< X > &xb)=0
virtual void output_func (Bag< X > &yb)=0
virtual double ta ()=0
virtual void gc_output (Bag< X > &g)=0
virtual ~Atomic ()
 Destructor.
Atomic< X > * typeIsAtomic ()
 Returns a pointer to this model.

Protected Member Functions

double getLastEventTime () const

Friends

class Simulator< X >
class Schedule< X >

Detailed Description

template<class X>
class adevs::Atomic< X >

Base type for all atomic DEVS models.


Member Function Documentation

template<class X>
virtual void adevs::Atomic< X >::delta_conf ( const Bag< X > &  xb  )  [pure virtual]

Confluent transition function.

Parameters:
xb Input for the model.

Implemented in adevs::DESS< X >, and adevs::Hybrid< X >.

template<class X>
virtual void adevs::Atomic< X >::delta_ext ( double  e,
const Bag< X > &  xb 
) [pure virtual]

External transition function.

Parameters:
e Time elapsed since the last change of state
xb Input for the model.

Implemented in adevs::DESS< X >, and adevs::Hybrid< X >.

template<class X>
virtual void adevs::Atomic< X >::gc_output ( Bag< X > &  g  )  [pure virtual]

Garbage collection function. The objects in g are no longer in use by the simulation engine and should be disposed of. ` * Note that the elements in g are only those objects produced as output by this model.

Implemented in adevs::Hybrid< X >.

template<class X>
double adevs::Atomic< X >::getLastEventTime (  )  const [inline, protected]

Get the last event time for this model. This is provided primarily for use with the backwards compatibility module and should not be relied on. It is likely to be removed in later versions of the code.

template<class X>
virtual void adevs::Atomic< X >::output_func ( Bag< X > &  yb  )  [pure virtual]

Output function. Output values should be added to the bag yb.

Parameters:
yb Empty bag to be filled with the model's output

Implemented in adevs::DESS< X >, and adevs::Hybrid< X >.

Referenced by adevs::Simulator< X >::computeNextOutput().

template<class X>
virtual double adevs::Atomic< X >::ta (  )  [pure virtual]

Time advance function. DBL_MAX is used for infinity.

Returns:
The time to the next internal event

Implemented in adevs::DESS< X >, and adevs::Hybrid< X >.


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