gcp::ReactionProp Class Reference
#include <gcp/reaction-prop.h>
List of all members.
Detailed Description
This is a container class for objects attached to a reaction arrow.
Definition at line 98 of file reaction-prop.h.
Constructor & Destructor Documentation
gcp::ReactionProp::ReactionProp |
( |
|
) |
|
- Parameters:
-
| parent | the parent reaction arrow. |
| child | the molecule or text to attach to the arrow. |
Builds a new reactionproperty, and attach the child to the arrow.
gcp::ReactionProp::~ReactionProp |
( |
|
) |
|
Member Function Documentation
gcp::ReactionProp::GetObject |
( |
void |
|
) |
const [inline] |
gcp::ReactionProp::GetRefRole |
( |
void |
|
) |
[inline] |
gcp::ReactionProp::GetRole |
( |
void |
|
) |
const [inline] |
bool gcp::ReactionProp::Load |
( |
xmlNodePtr |
node |
) |
[virtual] |
- Parameters:
-
| node,: | a pointer to the xmlNode containing the serialized reaction property. |
Used to load a reaction property in memory.
- Returns:
- true on succes, false otherwise.
Reimplemented from gcu::Object.
std::string gcp::ReactionProp::Name |
( |
|
) |
[virtual] |
- Returns:
- the localized object generic name.
Reimplemented from gcu::Object.
- Parameters:
-
| Signal | the appropriate SignalId |
| Child | the child which emitted the signal or NULL |
This function is called by the framework when a signal has been emitted for the reaction property, when one its emedded object changed. It should not be called by a program; call Object::EmitSignal instead.
- Returns:
- true to be propagate the signal to the parent.
Reimplemented from gcu::Object.
xmlNodePtr gcp::ReactionProp::Save |
( |
xmlDocPtr |
xml |
) |
|
- Parameters:
-
| xml | the xmlDoc used to save the document. |
Used to save the reaction property to the xmlDoc.
- Returns:
- the xmlNode containing the serialized reaction property.
gcp::ReactionProp::SetRole |
( |
unsigned |
Role |
) |
[inline] |
- Parameters:
-
| Role | the new role for the property. |
Sets the role for the property which should be less than REACTION_PROP_MAX.
Definition at line 164 of file reaction-prop.h.
The documentation for this class was generated from the following file: