ChainBase Class Reference

Detailed Description

base class for ChainHandle and ChainView

This class implements the common functionality of ChainHandle and ChainView.

Like residues and atoms, chains are generic property containers and a such able to store user-defined properties.

Chains are linear chains of residues. Peptide chains are ordered from N- to C-terminus.

Definition at line 38 of file chain_base.hh.

ChainBase ( )

ChainBase ( const impl::ChainImplPtr & impl )

void CheckValidity ( ) const [protected]

String GetName ( ) const

const GenericPropContainerImpl* GpImpl ( ) const [protected]

GenericPropContainerImpl* GpImpl ( ) [protected]

impl::ChainImplPtr& Impl ( ) [inline]

Definition at line 65 of file chain_base.hh.

const impl::ChainImplPtr& Impl ( ) const [inline]

Definition at line 61 of file chain_base.hh.

bool IsValid ( ) const

check validity of handle

operator bool ( ) const

check validity of handle

check, whether the chain handle points to a valid handle.

Note:: It is an error to use any method other than IsValid, Impl() and operator bool() when the handle is invalid. An InvalidHandle exception will be thrown.

friend class ConstGenericPropContainer< ChainBase > [friend]

Definition at line 45 of file chain_base.hh.

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


Public Member Functions
	ChainBase ()
	ChainBase (const impl::ChainImplPtr &impl)
String	GetName () const
const impl::ChainImplPtr &	Impl () const
impl::ChainImplPtr &	Impl ()
Handle validity
	operator bool () const
bool	IsValid () const
Protected Member Functions
GenericPropContainerImpl *	GpImpl ()
const GenericPropContainerImpl *	GpImpl () const
void	CheckValidity () const
Friends
class	ConstGenericPropContainer< ChainBase >