The Gnome Chemistry Utils  0.13.6
Public Member Functions
gcp::Step Class Reference

parent class for reaction steps, mesomers, and more. More...

#include <gcp/step.h>

Inheritance diagram for gcp::Step:
gcu::Object gcp::MechanismStep gcp::Mesomer gcp::ReactionStep

List of all members.

Public Member Functions

 Step (gcu::TypeId type)
virtual ~Step ()
void AddArrow (Arrow *arrow, Step *step) throw (std::invalid_argument)
void RemoveArrow (Arrow *arrow, Step *step)
bool Validate ()
std::map< Step *, Arrow * > * GetArrows ()

Detailed Description

parent class for reaction steps, mesomers, and more.

Definition at line 39 of file step.h.


Constructor & Destructor Documentation

The default constructor.

virtual gcp::Step::~Step ( ) [virtual]

The destructor.


Member Function Documentation

void gcp::Step::AddArrow ( Arrow arrow,
Step step 
) throw (std::invalid_argument)
Parameters:
arrowan arrow
stepthe Step at the other end of the arrow.

Adds the arrow to the arrows map. See Step::GetArrows().

std::map< Step *, Arrow * >* gcp::Step::GetArrows ( ) [inline]
Returns:
the map of all arrows pointing to this Step indexed by the Step at the other end of the arrow.

Reimplemented in gcp::Mesomer.

Definition at line 74 of file step.h.

void gcp::Step::RemoveArrow ( Arrow arrow,
Step step 
)
Parameters:
arrowan arrow
stepthe Step at the other end of the arrow.

Removes the arrow from the arrows map. See Step::GetArrows().

bool gcp::Step::Validate ( ) [inline]
Returns:
true if the step is associated with at least one arrow, false otherwise. See gcp::Scheme::Validate() for more information.

Reimplemented in gcp::ReactionStep, and gcp::Mesomer.

Definition at line 69 of file step.h.


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