#include <BondDirectionMatchExpression.hpp>

Inheritance diagram for CDPL::Chem::BondDirectionMatchExpression:

Public Types
typedef std::shared_ptr< BondDirectionMatchExpression >	SharedPointer
	A reference-counted smart pointer [SHPTR] for dynamically allocated `BondDirectionMatchExpression` instances. More...

Public Types inherited from CDPL::Chem::MatchExpression< Bond, MolecularGraph >
typedef std::shared_ptr< MatchExpression >	SharedPointer
	A reference-counted smart pointer [SHPTR] for dynamically allocated `MatchExpression` instances. More...

Public Member Functions
	BondDirectionMatchExpression (unsigned int dir_flags, bool not_match)
	Constructs an `BondDirectionMatchExpression` instance for the specified matching mode and bond direction constraints. More...

bool	operator() (const Bond &query_bond, const MolecularGraph &query_molgraph, const Bond &target_bond, const MolecularGraph &target_molgraph, const AtomBondMapping &mapping, const Base::Any &target_bond_dir) const
	Checks whether the direction given by target_bond_dir matches (or does not match) the direction constraints specified in the constructor. More...

Public Member Functions inherited from CDPL::Chem::MatchExpression< Bond, MolecularGraph >
virtual	~MatchExpression ()
	Virtual Destructor. More...

virtual bool	operator() (const Bond &query_obj1, const MolecularGraph &query_obj2, const Bond &target_obj1, const MolecularGraph &target_obj2, const Base::Any &aux_data) const
	Performs an evaluation of the expression for the given query and target objects. More...

virtual bool	operator() (const Bond &query_obj1, const MolecularGraph &query_obj2, const Bond &target_obj1, const MolecularGraph &target_obj2, const AtomBondMapping &mapping, const Base::Any &aux_data) const
	Performs an evaluation of the expression for the given query and target objects under consideration of the provided candidate atom/bond mapping. More...

virtual bool	requiresAtomBondMapping () const
	Tells whether the expression must be reevaluated after a query to target atom/bond mapping candidate has been found. More...

Detailed Description

BondDirectionMatchExpression.

Member Typedef Documentation

◆ SharedPointer

typedef std::shared_ptr<BondDirectionMatchExpression> CDPL::Chem::BondDirectionMatchExpression::SharedPointer

A reference-counted smart pointer [SHPTR] for dynamically allocated BondDirectionMatchExpression instances.

Constructor & Destructor Documentation

◆ BondDirectionMatchExpression()

CDPL::Chem::BondDirectionMatchExpression::BondDirectionMatchExpression	(	unsigned int	dir_flags,
		bool	not_match
	)

Constructs an BondDirectionMatchExpression instance for the specified matching mode and bond direction constraints.

Parameters

dir_flags	A bitwise OR combination of the flags defined in namespace Chem::BondDirection that specifies constraints on the direction of matching target bonds.
not_match	Specifies whether the direction of a target bond actually has to match (`true`) or not match (`false`) the query direction constraints.

Member Function Documentation

◆ operator()()

bool CDPL::Chem::BondDirectionMatchExpression::operator()	(	const Bond &	query_bond,
		const MolecularGraph &	query_molgraph,
		const Bond &	target_bond,
		const MolecularGraph &	target_molgraph,
		const AtomBondMapping &	mapping,
		const Base::Any &	target_bond_dir
	)		const

Checks whether the direction given by target_bond_dir matches (or does not match) the direction constraints specified in the constructor.

The specified query direction constraint flags are interpreted in a 'logical OR' manner. That is, the target bond direction specified by target_bond_dir only has to match (or not match) one of the specified query directions to satisfy the overall direction constraints. Note that only the flags defined in namespace Chem::BondDirection are supported - any other flags will be ignored.