Loading [MathJax]/extensions/tex2jax.js
Chemical Data Processing Library C++ API - Version 1.3.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Classes | Public Types | Public Member Functions | List of all members
CDPL::Chem::SubstructureEditor Class Reference

SubstructureEditor. More...

#include <SubstructureEditor.hpp>

Public Types

typedef std::shared_ptr< SubstructureEditorSharedPointer
 

Public Member Functions

 SubstructureEditor ()
 Constructs the SubstructureEditor instance. More...
 
 SubstructureEditor (const SubstructureEditor &editor)
 Constructs a copy of the SubstructureEditor instance editor. More...
 
 ~SubstructureEditor ()
 Destructor. More...
 
void addSearchPattern (const Chem::MolecularGraph::SharedPointer &pattern)
 Appends a new substructure search pattern to the current set of patterns. More...
 
void addExcludePattern (const Chem::MolecularGraph::SharedPointer &pattern)
 Appends a new substructure exclude pattern to the current set of patterns. More...
 
void clearSearchPatterns ()
 Clears the current set of substructuresearch patterns. More...
 
void clearExcludePatterns ()
 Clears the current set of substructure exclude patterns. More...
 
SubstructureEditoroperator= (const SubstructureEditor &gen)
 Copies the state of the SubstructureEditor instance gen. More...
 

Detailed Description

SubstructureEditor.

Since
1.3.0

Member Typedef Documentation

◆ SharedPointer

Constructor & Destructor Documentation

◆ SubstructureEditor() [1/2]

CDPL::Chem::SubstructureEditor::SubstructureEditor ( )

Constructs the SubstructureEditor instance.

◆ SubstructureEditor() [2/2]

CDPL::Chem::SubstructureEditor::SubstructureEditor ( const SubstructureEditor editor)

Constructs a copy of the SubstructureEditor instance editor.

Parameters
editorThe SubstructureEditor instance to copy.

◆ ~SubstructureEditor()

CDPL::Chem::SubstructureEditor::~SubstructureEditor ( )

Destructor.

Member Function Documentation

◆ addSearchPattern()

void CDPL::Chem::SubstructureEditor::addSearchPattern ( const Chem::MolecularGraph::SharedPointer pattern)

Appends a new substructure search pattern to the current set of patterns.

Parameters
patternThe substructure search pattern to add.

◆ addExcludePattern()

void CDPL::Chem::SubstructureEditor::addExcludePattern ( const Chem::MolecularGraph::SharedPointer pattern)

Appends a new substructure exclude pattern to the current set of patterns.

Parameters
patternThe substructure exclude pattern to add.

◆ clearSearchPatterns()

void CDPL::Chem::SubstructureEditor::clearSearchPatterns ( )

Clears the current set of substructuresearch patterns.

◆ clearExcludePatterns()

void CDPL::Chem::SubstructureEditor::clearExcludePatterns ( )

Clears the current set of substructure exclude patterns.

◆ operator=()

SubstructureEditor& CDPL::Chem::SubstructureEditor::operator= ( const SubstructureEditor gen)

Copies the state of the SubstructureEditor instance gen.

Parameters
genThe SubstructureEditor instance to copy.
Returns
A reference to itself.

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