Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes
gmx::RestraintManager::Impl Class Reference

Description

Implementation class for restraint manager.

Public Member Functions

void add (std::shared_ptr<::gmx::IRestraintPotential > restraint, const std::string &name)
 Implement Manager::addToSpec() More...
 
void clear () noexcept
 Clear registered restraints and reset the manager.
 

Public Attributes

std::vector< std::shared_ptr
<::gmx::IRestraintPotential > > 
restraint_
 The list of configured restraints. More...
 

Member Function Documentation

void gmx::RestraintManager::Impl::add ( std::shared_ptr<::gmx::IRestraintPotential restraint,
const std::string &  name 
)

Implement Manager::addToSpec()

Parameters
restraintHandle to be added to the manager.
nameIdentifying string for restraint.

Member Data Documentation

std::vector<std::shared_ptr<::gmx::IRestraintPotential> > gmx::RestraintManager::Impl::restraint_

The list of configured restraints.

Clients can extend the life of a restraint implementation object that is being used by holding the shared_ptr handle. A RestraintManager::Impl is logically const when its owning Manager is logically const, but the Manager can still grant access to individual restraints.


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