A handle to a dihedral bond. More...

#include <tfDihedral.h>

Public Member Functions
Dihedral *	get ()
	Gets the dihedral of this handle.

std::string	str () const
	Get a summary string of the dihedral.

bool	check ()
	Check the validity of the handle.

HRESULT	destroy ()
	Destroy the dihedral.

bool	decays ()
	Tests whether this bond decays.

ParticleHandle *	operator[] (unsigned int index)

bool	has (const int32_t &pid)

bool	has (ParticleHandle *part)

FloatP_t	getAngle ()

FPTYPE	getEnergy ()

std::vector< int32_t >	getParts ()

ParticleList	getPartList ()

Potential *	getPotential ()

uint32_t	getId ()

FPTYPE	getDissociationEnergy ()

void	setDissociationEnergy (const FPTYPE &dissociation_energy)

FPTYPE	getHalfLife ()

void	setHalfLife (const FPTYPE &half_life)

rendering::Style *	getStyle ()

void	setStyle (rendering::Style *style)

FPTYPE	getAge ()

	DihedralHandle (const int &_id)
	Construct a new dihedral handle from an existing dihedral id.

Static Public Member Functions
static std::vector< DihedralHandle >	items ()
	Gets all dihedrals in the universe.

Public Attributes
int	id

Detailed Description

A handle to a dihedral bond.

This is a safe way to work with a dihedral bond.

Constructor & Destructor Documentation

◆ DihedralHandle()

TissueForge::DihedralHandle::DihedralHandle ( const int & _id )

Construct a new dihedral handle from an existing dihedral id.

Parameters

id	id of existing dihedral

Member Function Documentation

◆ check()

bool TissueForge::DihedralHandle::check ( )

Check the validity of the handle.

Returns: true if ok; false

◆ decays()

bool TissueForge::DihedralHandle::decays ( )

Tests whether this bond decays.

Returns: true when the bond should decay

◆ get()

Dihedral * TissueForge::DihedralHandle::get ( )

Gets the dihedral of this handle.

Returns: dihedral, if available

◆ getAge()

FPTYPE TissueForge::DihedralHandle::getAge ( )

Get the age

◆ getAngle()

FloatP_t TissueForge::DihedralHandle::getAngle ( )

Get the current angle

◆ getDissociationEnergy()

FPTYPE TissueForge::DihedralHandle::getDissociationEnergy ( )

Get the dissociation energy

◆ getEnergy()

FPTYPE TissueForge::DihedralHandle::getEnergy ( )

Get the energy

◆ getHalfLife()

FPTYPE TissueForge::DihedralHandle::getHalfLife ( )

Get the half life

◆ getId()

uint32_t TissueForge::DihedralHandle::getId ( )

Get the id

◆ getPartList()

ParticleList TissueForge::DihedralHandle::getPartList ( )

Get the particle list

◆ getParts()

std::vector< int32_t > TissueForge::DihedralHandle::getParts ( )

Get the particle ids

◆ getPotential()

Potential * TissueForge::DihedralHandle::getPotential ( )

Get the potential

◆ getStyle()

rendering::Style * TissueForge::DihedralHandle::getStyle ( )

Get the style

◆ has() [1/2]

bool TissueForge::DihedralHandle::has ( const int32_t & pid )

Test whether the bond has an id

◆ has() [2/2]

bool TissueForge::DihedralHandle::has ( ParticleHandle * part )

Test whether the bond has a particle

◆ setDissociationEnergy()

void TissueForge::DihedralHandle::setDissociationEnergy ( const FPTYPE & dissociation_energy )

Set the dissociation energy

◆ setHalfLife()

void TissueForge::DihedralHandle::setHalfLife ( const FPTYPE & half_life )

Set the half life

◆ setStyle()

void TissueForge::DihedralHandle::setStyle ( rendering::Style * style )

Set the style

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

source/mdcore/include/tfDihedral.h

Public Member Functions

Static Public Member Functions

Public Attributes