Chemical Data Processing Library C++ API - Version 1.4.0
Namespaces | Functions
Vis/ReactionFunctions.hpp File Reference

Declaration of functions that operate on Chem::Reaction instances. More...

#include "CDPL/Vis/APIPrefix.hpp"

Go to the source code of this file.

Namespaces

 CDPL
 The namespace of the Chemical Data Processing Library.
 
 CDPL::Chem
 Contains classes and functions related to chemistry.
 
 CDPL::Vis
 Contains classes and functions related to data visualization.
 

Functions

CDPL_VIS_API unsigned int CDPL::Vis::getArrowStyle (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::ARROW_STYLE property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setArrowStyle (Chem::Reaction &rxn, unsigned int style)
 Sets the value of the Vis::ReactionProperty::ARROW_STYLE property of the reaction rxn to style. More...
 
CDPL_VIS_API bool CDPL::Vis::hasArrowStyle (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::ARROW_STYLE property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearArrowStyle (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::ARROW_STYLE property of the reaction rxn. More...
 
CDPL_VIS_API const Color & CDPL::Vis::getArrowColor (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::ARROW_COLOR property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setArrowColor (Chem::Reaction &rxn, const Color &color)
 Sets the value of the Vis::ReactionProperty::ARROW_COLOR property of the reaction rxn to color. More...
 
CDPL_VIS_API bool CDPL::Vis::hasArrowColor (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::ARROW_COLOR property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearArrowColor (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::ARROW_COLOR property of the reaction rxn. More...
 
CDPL_VIS_API const SizeSpecification & CDPL::Vis::getArrowLength (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::ARROW_LENGTH property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setArrowLength (Chem::Reaction &rxn, const SizeSpecification &length)
 Sets the value of the Vis::ReactionProperty::ARROW_LENGTH property of the reaction rxn to length. More...
 
CDPL_VIS_API bool CDPL::Vis::hasArrowLength (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::ARROW_LENGTH property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearArrowLength (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::ARROW_LENGTH property of the reaction rxn. More...
 
CDPL_VIS_API const SizeSpecification & CDPL::Vis::getArrowHeadLength (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::ARROW_HEAD_LENGTH property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setArrowHeadLength (Chem::Reaction &rxn, const SizeSpecification &length)
 Sets the value of the Vis::ReactionProperty::ARROW_HEAD_LENGTH property of the reaction rxn to length. More...
 
CDPL_VIS_API bool CDPL::Vis::hasArrowHeadLength (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::ARROW_HEAD_LENGTH property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearArrowHeadLength (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::ARROW_HEAD_LENGTH property of the reaction rxn. More...
 
CDPL_VIS_API const SizeSpecification & CDPL::Vis::getArrowHeadWidth (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::ARROW_HEAD_WIDTH property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setArrowHeadWidth (Chem::Reaction &rxn, const SizeSpecification &width)
 Sets the value of the Vis::ReactionProperty::ARROW_HEAD_WIDTH property of the reaction rxn to width. More...
 
CDPL_VIS_API bool CDPL::Vis::hasArrowHeadWidth (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::ARROW_HEAD_WIDTH property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearArrowHeadWidth (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::ARROW_HEAD_WIDTH property of the reaction rxn. More...
 
CDPL_VIS_API const SizeSpecification & CDPL::Vis::getArrowShaftWidth (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::ARROW_SHAFT_WIDTH property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setArrowShaftWidth (Chem::Reaction &rxn, const SizeSpecification &width)
 Sets the value of the Vis::ReactionProperty::ARROW_SHAFT_WIDTH property of the reaction rxn to width. More...
 
CDPL_VIS_API bool CDPL::Vis::hasArrowShaftWidth (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::ARROW_SHAFT_WIDTH property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearArrowShaftWidth (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::ARROW_SHAFT_WIDTH property of the reaction rxn. More...
 
CDPL_VIS_API const SizeSpecification & CDPL::Vis::getArrowLineWidth (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::ARROW_LINE_WIDTH property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setArrowLineWidth (Chem::Reaction &rxn, const SizeSpecification &width)
 Sets the value of the Vis::ReactionProperty::ARROW_LINE_WIDTH property of the reaction rxn to width. More...
 
CDPL_VIS_API bool CDPL::Vis::hasArrowLineWidth (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::ARROW_LINE_WIDTH property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearArrowLineWidth (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::ARROW_LINE_WIDTH property of the reaction rxn. More...
 
CDPL_VIS_API unsigned int CDPL::Vis::getComponentLayout (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::COMPONENT_LAYOUT property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setComponentLayout (Chem::Reaction &rxn, unsigned int layout)
 Sets the value of the Vis::ReactionProperty::COMPONENT_LAYOUT property of the reaction rxn to layout. More...
 
CDPL_VIS_API bool CDPL::Vis::hasComponentLayout (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::COMPONENT_LAYOUT property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearComponentLayout (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::COMPONENT_LAYOUT property of the reaction rxn. More...
 
CDPL_VIS_API unsigned int CDPL::Vis::getComponentLayoutDirection (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::COMPONENT_LAYOUT_DIRECTION property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setComponentLayoutDirection (Chem::Reaction &rxn, unsigned int dir)
 Sets the value of the Vis::ReactionProperty::COMPONENT_LAYOUT_DIRECTION property of the reaction rxn to dir. More...
 
CDPL_VIS_API bool CDPL::Vis::hasComponentLayoutDirection (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::COMPONENT_LAYOUT_DIRECTION property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearComponentLayoutDirection (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::COMPONENT_LAYOUT_DIRECTION property of the reaction rxn. More...
 
CDPL_VIS_API const SizeSpecification & CDPL::Vis::getComponentMargin (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::COMPONENT_MARGIN property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setComponentMargin (Chem::Reaction &rxn, const SizeSpecification &margin)
 Sets the value of the Vis::ReactionProperty::COMPONENT_MARGIN property of the reaction rxn to margin. More...
 
CDPL_VIS_API bool CDPL::Vis::hasComponentMargin (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::COMPONENT_MARGIN property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearComponentMargin (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::COMPONENT_MARGIN property of the reaction rxn. More...
 
CDPL_VIS_API bool CDPL::Vis::getShowReactants (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::SHOW_REACTANTS property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setShowReactants (Chem::Reaction &rxn, bool show)
 Sets the value of the Vis::ReactionProperty::SHOW_REACTANTS property of the reaction rxn to show. More...
 
CDPL_VIS_API bool CDPL::Vis::hasShowReactants (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::SHOW_REACTANTS property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearShowReactants (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::SHOW_REACTANTS property of the reaction rxn. More...
 
CDPL_VIS_API bool CDPL::Vis::getShowAgents (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::SHOW_AGENTS property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setShowAgents (Chem::Reaction &rxn, bool show)
 Sets the value of the Vis::ReactionProperty::SHOW_AGENTS property of the reaction rxn to show. More...
 
CDPL_VIS_API bool CDPL::Vis::hasShowAgents (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::SHOW_AGENTS property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearShowAgents (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::SHOW_AGENTS property of the reaction rxn. More...
 
CDPL_VIS_API bool CDPL::Vis::getShowProducts (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::SHOW_PRODUCTS property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setShowProducts (Chem::Reaction &rxn, bool show)
 Sets the value of the Vis::ReactionProperty::SHOW_PRODUCTS property of the reaction rxn to show. More...
 
CDPL_VIS_API bool CDPL::Vis::hasShowProducts (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::SHOW_PRODUCTS property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearShowProducts (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::SHOW_PRODUCTS property of the reaction rxn. More...
 
CDPL_VIS_API unsigned int CDPL::Vis::getAgentAlignment (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::AGENT_ALIGNMENT property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setAgentAlignment (Chem::Reaction &rxn, unsigned int alignment)
 Sets the value of the Vis::ReactionProperty::AGENT_ALIGNMENT property of the reaction rxn to alignment. More...
 
CDPL_VIS_API bool CDPL::Vis::hasAgentAlignment (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::AGENT_ALIGNMENT property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearAgentAlignment (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::AGENT_ALIGNMENT property of the reaction rxn. More...
 
CDPL_VIS_API unsigned int CDPL::Vis::getAgentLayout (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::AGENT_LAYOUT property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setAgentLayout (Chem::Reaction &rxn, unsigned int layout)
 Sets the value of the Vis::ReactionProperty::AGENT_LAYOUT property of the reaction rxn to layout. More...
 
CDPL_VIS_API bool CDPL::Vis::hasAgentLayout (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::AGENT_LAYOUT property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearAgentLayout (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::AGENT_LAYOUT property of the reaction rxn. More...
 
CDPL_VIS_API unsigned int CDPL::Vis::getAgentLayoutDirection (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::AGENT_LAYOUT_DIRECTION property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setAgentLayoutDirection (Chem::Reaction &rxn, unsigned int dir)
 Sets the value of the Vis::ReactionProperty::AGENT_LAYOUT_DIRECTION property of the reaction rxn to dir. More...
 
CDPL_VIS_API bool CDPL::Vis::hasAgentLayoutDirection (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::AGENT_LAYOUT_DIRECTION property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearAgentLayoutDirection (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::AGENT_LAYOUT_DIRECTION property of the reaction rxn. More...
 
CDPL_VIS_API const Color & CDPL::Vis::getPlusSignColor (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::PLUS_SIGN_COLOR property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setPlusSignColor (Chem::Reaction &rxn, const Color &color)
 Sets the value of the Vis::ReactionProperty::PLUS_SIGN_COLOR property of the reaction rxn to color. More...
 
CDPL_VIS_API bool CDPL::Vis::hasPlusSignColor (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::PLUS_SIGN_COLOR property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearPlusSignColor (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::PLUS_SIGN_COLOR property of the reaction rxn. More...
 
CDPL_VIS_API const SizeSpecification & CDPL::Vis::getPlusSignSize (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::PLUS_SIGN_SIZE property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setPlusSignSize (Chem::Reaction &rxn, const SizeSpecification &size)
 Sets the value of the Vis::ReactionProperty::PLUS_SIGN_SIZE property of the reaction rxn to size. More...
 
CDPL_VIS_API bool CDPL::Vis::hasPlusSignSize (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::PLUS_SIGN_SIZE property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearPlusSignSize (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::PLUS_SIGN_SIZE property of the reaction rxn. More...
 
CDPL_VIS_API const SizeSpecification & CDPL::Vis::getPlusSignLineWidth (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::PLUS_SIGN_LINE_WIDTH property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setPlusSignLineWidth (Chem::Reaction &rxn, const SizeSpecification &width)
 Sets the value of the Vis::ReactionProperty::PLUS_SIGN_LINE_WIDTH property of the reaction rxn to width. More...
 
CDPL_VIS_API bool CDPL::Vis::hasPlusSignLineWidth (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::PLUS_SIGN_LINE_WIDTH property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearPlusSignLineWidth (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::PLUS_SIGN_LINE_WIDTH property of the reaction rxn. More...
 
CDPL_VIS_API bool CDPL::Vis::getShowPlusSigns (const Chem::Reaction &rxn)
 Returns the value of the Vis::ReactionProperty::SHOW_PLUS_SIGNS property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::setShowPlusSigns (Chem::Reaction &rxn, bool show)
 Sets the value of the Vis::ReactionProperty::SHOW_PLUS_SIGNS property of the reaction rxn to show. More...
 
CDPL_VIS_API bool CDPL::Vis::hasShowPlusSigns (const Chem::Reaction &rxn)
 Tells whether the Vis::ReactionProperty::SHOW_PLUS_SIGNS property of the reaction rxn is set. More...
 
CDPL_VIS_API void CDPL::Vis::clearShowPlusSigns (Chem::Reaction &rxn)
 Clears the value of the Vis::ReactionProperty::SHOW_PLUS_SIGNS property of the reaction rxn. More...
 
CDPL_VIS_API void CDPL::Vis::prepareFor2DVisualization (Chem::Reaction &rxn)
 Prepares rxn for 2D visualization by perceiving all properties (aromaticity, hybridization, rings, stereo, etc.) that downstream 2D-rendering code expects to be set on each reaction component. More...
 

Detailed Description

Declaration of functions that operate on Chem::Reaction instances.