Generated on Wed Apr 29 2015 11:51:41 for GGL-4.1.2 by doxygen 1.8.3.1
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT > Struct Template Reference

The definition of the GML grammar.

#include <MoleculeComponent_GML_grammar.hh>

Public Member Functions

 definition (const MoleculeComponent_GML_grammar &self)
 
NS_BOOSTSPIRIT::rule< ScannerT >
const & 
start () const
 start parsing More...
 

Protected Types

enum  WhatList {
  Fill_constrAdj_NL, Fill_constrAdj_EL, Fill_constrLabel_NL, Fill_compIDs,
  Fill_ringFragments
}
 

Protected Member Functions

void clear_toFill (void)
 
void final_checks (void) throw (std::invalid_argument)
 
void insert_to_list (WhatList list)
 
void store_constrAdj (void)
 
void store_constrLabel (void)
 
void store_edge (void) throw (std::invalid_argument)
 
void store_node (void) throw (std::invalid_argument)
 

Protected Attributes

NS_BOOSTSPIRIT::rule< ScannerT > compIDs
 
MC_MC_NodeAdjacency constrAdj
 
char constrAdjOp
 
NS_BOOSTSPIRIT::rule< ScannerT > constrainAdjacency
 
NS_BOOSTSPIRIT::rule< ScannerT > constrainLabel
 
MC_MC_NodeLabel constrLabel
 
char constrLabelOp
 
NS_BOOSTSPIRIT::rule< ScannerT > content
 
int curEdgeFromID
 
std::string curEdgeLabel
 
int curEdgeToID
 
int curNodeID
 
std::string curNodeLabel
 
MoleculeComponent::RingFragmentList curRingFragmentList
 
std::string curRingFragmentTypeString
 
NS_BOOSTSPIRIT::rule< ScannerT > edge
 
boost::property_map
< MoleculeComponent::PatternGraph,
PropEdgeLabel >::type 
edgeLabel
 Access to the edge label property_map of g2fill to set edge labels. More...
 
NS_BOOSTSPIRIT::rule< ScannerT > molcomp
 the rules to be parsed More...
 
NS_BOOSTSPIRIT::rule< ScannerT > node
 
boost::property_map
< MoleculeComponent::PatternGraph,
PropNodeLabel >::type 
nodeLabel
 Access to the node label property_map of toFill to set node labels. More...
 
MapIntSizeT nodeMapping
 
NS_BOOSTSPIRIT::rule< ScannerT > ringFragment
 
MoleculeComponenttoFill
 the molecule component to be filled More...
 

Detailed Description

template<typename ScannerT>
struct ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >

Definition at line 140 of file MoleculeComponent_GML_grammar.hh.

Member Enumeration Documentation

template<typename ScannerT >
enum ggl::chem::MoleculeComponent_GML_grammar::definition::WhatList
protected
Enumerator
Fill_constrAdj_NL 
Fill_constrAdj_EL 
Fill_constrLabel_NL 
Fill_compIDs 
Fill_ringFragments 

Definition at line 187 of file MoleculeComponent_GML_grammar.hh.

Constructor & Destructor Documentation

template<typename ScannerT >
ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::definition ( const MoleculeComponent_GML_grammar self)

Construction of the GML BNF grammar rules to parse a MoleculeComponent

Parameters
selfaccess to the calling grammar

Member Function Documentation

template<typename ScannerT >
void ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::clear_toFill ( void  )
protected

Resets toFill to enable the detection of missing information within final_checks()

template<typename ScannerT >
void ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::final_checks ( void  ) throw (std::invalid_argument)
protected

Performs final checks on toFill to ensure that the parse was correct

Exceptions
std::invalid_argumentin case a check fails
template<typename ScannerT >
void ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::insert_to_list ( WhatList  list)
protected

Inserts a string into a given string set

Parameters
listthe encoding which list to be fill
template<typename ScannerT >
NS_BOOSTSPIRIT::rule<ScannerT> const& ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::start ( ) const
template<typename ScannerT >
void ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::store_constrAdj ( void  )
protected

Stores a node adjacency constraint of the MoleculeComponent

template<typename ScannerT >
void ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::store_constrLabel ( void  )
protected

Stores a node label constraint of the MoleculeComponent

template<typename ScannerT >
void ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::store_edge ( void  ) throw (std::invalid_argument)
protected

Stores an edge of the MoleculeComponent pattern graph.

Exceptions
std::invalid_argumentin case a check fails
template<typename ScannerT >
void ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::store_node ( void  ) throw (std::invalid_argument)
protected

Stores a node of the MoleculeComponent pattern graph.

Exceptions
std::invalid_argumentin case a check fails

Field Documentation

template<typename ScannerT >
NS_BOOSTSPIRIT::rule<ScannerT> ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::compIDs
protected

Definition at line 173 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
MC_MC_NodeAdjacency ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::constrAdj
protected

Definition at line 182 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
char ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::constrAdjOp
protected

Definition at line 183 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
NS_BOOSTSPIRIT::rule<ScannerT> ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::constrainAdjacency
protected

Definition at line 173 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
NS_BOOSTSPIRIT::rule<ScannerT> ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::constrainLabel
protected

Definition at line 173 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
MC_MC_NodeLabel ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::constrLabel
protected

Definition at line 184 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
char ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::constrLabelOp
protected

Definition at line 183 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
NS_BOOSTSPIRIT::rule<ScannerT> ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::content
protected

Definition at line 173 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
int ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::curEdgeFromID
protected

Definition at line 178 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
std::string ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::curEdgeLabel
protected

Definition at line 179 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
int ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::curEdgeToID
protected

Definition at line 178 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
int ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::curNodeID
protected

Definition at line 178 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
std::string ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::curNodeLabel
protected

Definition at line 179 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
MoleculeComponent::RingFragmentList ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::curRingFragmentList
protected

Definition at line 185 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
std::string ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::curRingFragmentTypeString
protected

Definition at line 180 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
NS_BOOSTSPIRIT::rule<ScannerT> ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::edge
protected

Definition at line 173 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
boost::property_map< MoleculeComponent::PatternGraph, PropEdgeLabel>::type ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::edgeLabel
protected

Definition at line 165 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
NS_BOOSTSPIRIT::rule<ScannerT> ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::molcomp
protected

Definition at line 173 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
NS_BOOSTSPIRIT::rule<ScannerT> ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::node
protected

Definition at line 173 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
boost::property_map< MoleculeComponent::PatternGraph, PropNodeLabel>::type ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::nodeLabel
protected

Definition at line 161 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
MapIntSizeT ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::nodeMapping
protected

the mapping of node IDs in the GML notation and their corresponding node IDs in the created pattern graph

Definition at line 169 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
NS_BOOSTSPIRIT::rule<ScannerT> ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::ringFragment
protected

Definition at line 173 of file MoleculeComponent_GML_grammar.hh.

template<typename ScannerT >
MoleculeComponent& ggl::chem::MoleculeComponent_GML_grammar::definition< ScannerT >::toFill
protected

Definition at line 157 of file MoleculeComponent_GML_grammar.hh.


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