Chemical Data Processing Library C++ API - Version 1.2.0
Classes | Public Member Functions | List of all members
CDPL::Chem::Atom2DCoordinatesCalculator Class Reference

Atom2DCoordinatesCalculator. More...

#include <Atom2DCoordinatesCalculator.hpp>

Public Member Functions

 Atom2DCoordinatesCalculator ()
 Constructs the Atom2DCoordinatesCalculator instance. More...
 
 Atom2DCoordinatesCalculator (const MolecularGraph &molgraph, Math::Vector2DArray &coords)
 Constructs the Atom2DCoordinatesCalculator instance and calculates 2D-coordinates for the atoms of the molecular graph molgraph. More...
 
 Atom2DCoordinatesCalculator (const Atom2DCoordinatesCalculator &)=delete
 
Atom2DCoordinatesCalculatoroperator= (const Atom2DCoordinatesCalculator &)=delete
 
void calculate (const MolecularGraph &molgraph, Math::Vector2DArray &coords)
 Calculates 2D-coordinates for the atoms of the molecular graph molgraph. More...
 

Detailed Description

Atom2DCoordinatesCalculator.

Constructor & Destructor Documentation

◆ Atom2DCoordinatesCalculator() [1/3]

CDPL::Chem::Atom2DCoordinatesCalculator::Atom2DCoordinatesCalculator ( )

Constructs the Atom2DCoordinatesCalculator instance.

◆ Atom2DCoordinatesCalculator() [2/3]

CDPL::Chem::Atom2DCoordinatesCalculator::Atom2DCoordinatesCalculator ( const MolecularGraph molgraph,
Math::Vector2DArray coords 
)

Constructs the Atom2DCoordinatesCalculator instance and calculates 2D-coordinates for the atoms of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to calculate 2D-coordinates.
coordsAn array containing the calculated 2D-coordinates. The coordinates are stored in the same order as the atoms appear in the atom list of the molecular graph (i.e. the coordinates of an atom are accessible via its index).

◆ Atom2DCoordinatesCalculator() [3/3]

CDPL::Chem::Atom2DCoordinatesCalculator::Atom2DCoordinatesCalculator ( const Atom2DCoordinatesCalculator )
delete

Member Function Documentation

◆ operator=()

Atom2DCoordinatesCalculator& CDPL::Chem::Atom2DCoordinatesCalculator::operator= ( const Atom2DCoordinatesCalculator )
delete

◆ calculate()

void CDPL::Chem::Atom2DCoordinatesCalculator::calculate ( const MolecularGraph molgraph,
Math::Vector2DArray coords 
)

Calculates 2D-coordinates for the atoms of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to calculate 2D-coordinates.
coordsAn array containing the calculated 2D-coordinates. The coordinates are stored in the same order as the atoms appear in the atom list of the molecular graph (i.e. the coordinates of an atom are accessible via its index).

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