ScriptInterface::Interactions::BondedInteraction Class Reference

#include <BondedInteraction.hpp>

Inheritance diagram for ScriptInterface::Interactions::BondedInteraction:

Collaboration diagram for ScriptInterface::Interactions::BondedInteraction:

Public Member Functions
std::shared_ptr<::Bonded_IA_Parameters >	bonded_ia ()
std::shared_ptr< const ::Bonded_IA_Parameters >	bonded_ia () const
bool	operator== (BondedInteraction const &other) const
Variant	do_call_method (std::string const &name, VariantMap const &params) override
Public Member Functions inherited from ScriptInterface::AutoParameters< BondedInteraction >
std::span< const boost::string_ref >	valid_parameters () const final
Variant	get_parameter (const std::string &name) const final
void	do_set_parameter (const std::string &name, const Variant &value) final
std::vector< std::pair< std::string, Variant > >	serialize_parameters () const final
Public Member Functions inherited from ScriptInterface::ObjectHandle
	ObjectHandle ()=default
	ObjectHandle (ObjectHandle const &)=delete
ObjectHandle &	operator= (ObjectHandle const &)=delete
virtual	~ObjectHandle ()=default
boost::string_ref	name () const
Context *	context () const
	Responsible context.
void	construct (VariantMap const &params)
	Construct the handled object.
VariantMap	get_parameters () const
	Get current parameters.
auto	get_valid_parameters () const
void	set_parameter (const std::string &name, const Variant &value)
	Set single parameter.
Variant	call_method (const std::string &name, const VariantMap &params)
	Call a method on the object.
std::string	serialize () const

Protected Member Functions
virtual std::set< std::string >	get_valid_parameters () const
Protected Member Functions inherited from ScriptInterface::AutoParameters< BondedInteraction >
	AutoParameters ()=default
	AutoParameters (std::vector< AutoParameter > &&params)
void	add_parameters (std::vector< AutoParameter > &&params)
auto const &	get_parameter_insertion_order () const

Protected Attributes
std::shared_ptr<::Bonded_IA_Parameters >	m_bonded_ia

Private Member Functions
void	do_construct (VariantMap const &params) override
virtual void	construct_bond (VariantMap const &params)=0

Additional Inherited Members
Static Public Member Functions inherited from ScriptInterface::ObjectHandle
static ObjectRef	deserialize (const std::string &state, Context &ctx)
	Make object from serialized state.

Detailed Description

Definition at line 56 of file BondedInteraction.hpp.

Member Function Documentation

bonded_ia() [1/2]

std::shared_ptr<::Bonded_IA_Parameters > ScriptInterface::Interactions::BondedInteraction::bonded_ia ( )

inline

Definition at line 61 of file BondedInteraction.hpp.

References m_bonded_ia.

bonded_ia() [2/2]

std::shared_ptr< const ::Bonded_IA_Parameters > ScriptInterface::Interactions::BondedInteraction::bonded_ia ( ) const

inline

Definition at line 62 of file BondedInteraction.hpp.

References m_bonded_ia.

construct_bond()

virtual void ScriptInterface::Interactions::BondedInteraction::construct_bond ( VariantMap const &  params )

privatepure virtual

Implemented in ScriptInterface::Interactions::VirtualBond, ScriptInterface::Interactions::FeneBond, ScriptInterface::Interactions::HarmonicBond, ScriptInterface::Interactions::QuarticBond, ScriptInterface::Interactions::BondedCoulomb, ScriptInterface::Interactions::BondedCoulombSR, ScriptInterface::Interactions::AngleHarmonicBond, ScriptInterface::Interactions::AngleCosineBond, ScriptInterface::Interactions::AngleCossquareBond, ScriptInterface::Interactions::DihedralBond, ScriptInterface::Interactions::TabulatedDistanceBond, ScriptInterface::Interactions::TabulatedAngleBond, ScriptInterface::Interactions::TabulatedDihedralBond, ScriptInterface::Interactions::ThermalizedBond, ScriptInterface::Interactions::RigidBond, ScriptInterface::Interactions::IBMTriel, ScriptInterface::Interactions::IBMVolCons, ScriptInterface::Interactions::IBMTribend, ScriptInterface::Interactions::OifGlobalForcesBond, and ScriptInterface::Interactions::OifLocalForcesBond.

do_call_method()

Variant ScriptInterface::Interactions::BondedInteraction::do_call_method ( std::string const &  name, VariantMap const &  params  )

inlineoverridevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Reimplemented in ScriptInterface::Interactions::IBMVolCons.

Definition at line 109 of file BondedInteraction.hpp.

References ScriptInterface::get_value(), number_of_partners(), and params.

do_construct()

void ScriptInterface::Interactions::BondedInteraction::do_construct ( VariantMap const &  params )

inlineoverrideprivatevirtual

Reimplemented from ScriptInterface::ObjectHandle.

Definition at line 95 of file BondedInteraction.hpp.

References params.

get_valid_parameters()

virtual std::set< std::string > ScriptInterface::Interactions::BondedInteraction::get_valid_parameters ( ) const

inlineprotectedvirtual

Definition at line 70 of file BondedInteraction.hpp.

References ScriptInterface::get_value(), and ScriptInterface::AutoParameters< BondedInteraction >::valid_parameters().

operator==()

bool ScriptInterface::Interactions::BondedInteraction::operator== ( BondedInteraction const &  other ) const

inline

Definition at line 105 of file BondedInteraction.hpp.

References ScriptInterface::get_value().

Member Data Documentation

m_bonded_ia

std::shared_ptr<::Bonded_IA_Parameters> ScriptInterface::Interactions::BondedInteraction::m_bonded_ia

protected

Definition at line 58 of file BondedInteraction.hpp.

Referenced by bonded_ia(), and bonded_ia().

---

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

• BondedInteraction.hpp