oasys::InitStep Class Reference

#include <InitSequencer.h>

Inheritance diagram for oasys::InitStep:

oasys::InitConfigStep List of all members.

Detailed Description

A single step in the dependency ordering.

Definition at line 148 of file InitSequencer.h.

Public Types

typedef std::vector< std::string > DepList

Public Member Functions

 InitStep (const std::string &the_namespace, const std::string &name)
 InitStep (const std::string &the_namespace, const std::string &name, int depsize,...)
 InitStep (const std::string &the_namespace, const std::string &name, const DepList &deps)
virtual ~InitStep ()
virtual int run ()
 Run this component.
bool dep_are_satisfied ()
 
Returns:
true if all dependencies have been met.

const DepListdependencies ()
std::string name ()
bool done ()
int time ()

Protected Member Functions

virtual int run_component ()=0
 Override this to start the component.

Protected Attributes

bool done_

Private Member Functions

void add_dep (const std::string &dep)

Private Attributes

std::string name_
DepList dependencies_
bool mark_
int time_

Friends

class InitSequencer


Member Typedef Documentation

typedef std::vector<std::string> oasys::InitStep::DepList

Definition at line 152 of file InitSequencer.h.


Constructor & Destructor Documentation

oasys::InitStep::InitStep ( const std::string &  the_namespace,
const std::string &  name 
)

Takes a list of depsize (const char*) dependency names.

Definition at line 294 of file InitSequencer.cc.

oasys::InitStep::InitStep ( const std::string &  the_namespace,
const std::string &  name,
int  depsize,
  ... 
)

Definition at line 304 of file InitSequencer.cc.

References dependencies_.

oasys::InitStep::InitStep ( const std::string &  the_namespace,
const std::string &  name,
const DepList deps 
)

Definition at line 322 of file InitSequencer.cc.

virtual oasys::InitStep::~InitStep (  )  [inline, virtual]

Definition at line 163 of file InitSequencer.h.


Member Function Documentation

int oasys::InitStep::run (  )  [virtual]

Run this component.

Returns 0 on no error.

Reimplemented in oasys::InitConfigStep.

Definition at line 334 of file InitSequencer.cc.

References done_, and run_component().

bool oasys::InitStep::dep_are_satisfied (  ) 

Returns:
true if all dependencies have been met.

Definition at line 346 of file InitSequencer.cc.

References dependencies_.

const DepList& oasys::InitStep::dependencies (  )  [inline]

Definition at line 175 of file InitSequencer.h.

References dependencies_.

std::string oasys::InitStep::name (  )  [inline]

Definition at line 176 of file InitSequencer.h.

References name_.

Referenced by oasys::InitSequencer::add_step(), and oasys::InitSequencer::dfs().

bool oasys::InitStep::done (  )  [inline]

Definition at line 177 of file InitSequencer.h.

References done_.

int oasys::InitStep::time (  )  [inline]

Definition at line 178 of file InitSequencer.h.

References time_.

Referenced by oasys::InitStepSort::operator()().

virtual int oasys::InitStep::run_component (  )  [protected, pure virtual]

Override this to start the component.

Implemented in oasys::InitConfigStep.

Referenced by run().

void oasys::InitStep::add_dep ( const std::string &  dep  )  [inline, private]

Definition at line 193 of file InitSequencer.h.

References dependencies_.


Friends And Related Function Documentation

friend class InitSequencer [friend]

Definition at line 149 of file InitSequencer.h.


Member Data Documentation

bool oasys::InitStep::done_ [protected]

Definition at line 181 of file InitSequencer.h.

Referenced by oasys::InitConfigStep::configuration_done(), done(), and run().

std::string oasys::InitStep::name_ [private]

Definition at line 187 of file InitSequencer.h.

Referenced by name().

DepList oasys::InitStep::dependencies_ [private]

Definition at line 188 of file InitSequencer.h.

Referenced by add_dep(), dep_are_satisfied(), dependencies(), and InitStep().

bool oasys::InitStep::mark_ [private]

Definition at line 190 of file InitSequencer.h.

int oasys::InitStep::time_ [private]

Definition at line 191 of file InitSequencer.h.

Referenced by oasys::InitSequencer::dfs(), and time().


The documentation for this class was generated from the following files:
Generated on Thu Jun 7 16:57:02 2007 for DTN Reference Implementation by  doxygen 1.5.1