BALL  1.4.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
BALL::Nucleotide Class Reference

#include <BALL/KERNEL/nucleotide.h>

Inheritance diagram for BALL::Nucleotide:
BALL::Fragment BALL::AtomContainer BALL::Composite BALL::PropertyManager BALL::PersistentObject BALL::Selectable BALL::Object BALL::AutoDeletable

Public Types

Enums
enum  Property { PROPERTY__5_PRIME = Residue::NUMBER_OF_PROPERTIES + 1, PROPERTY__3_PRIME, PROPERTY__NUCLEOTIDE, NUMBER_OF_PROPERTIES }
 
- Public Types inherited from BALL::Fragment
enum  Property { NUMBER_OF_PROPERTIES = AtomContainer::NUMBER_OF_PROPERTIES }
 
- Public Types inherited from BALL::AtomContainer
enum  Property { NUMBER_OF_PROPERTIES = 0 }
 The number of predefined properties for AtomContainer. More...
 
- Public Types inherited from BALL::Composite
typedef ForwardIterator
< Composite, Composite,
Composite
*, AncestorIteratorTraits
AncestorIterator
 
typedef ConstForwardIterator
< Composite, Composite,
Composite
*, AncestorIteratorTraits
AncestorConstIterator
 
typedef BidirectionalIterator
< Composite, Composite,
Composite
*, ChildCompositeIteratorTraits
ChildCompositeIterator
 
typedef
ConstBidirectionalIterator
< Composite, Composite,
Composite
*, ChildCompositeIteratorTraits
ChildCompositeConstIterator
 
typedef std::reverse_iterator
< ChildCompositeIterator
ChildCompositeReverseIterator
 
typedef std::reverse_iterator
< ChildCompositeConstIterator
ChildCompositeConstReverseIterator
 
typedef BidirectionalIterator
< Composite, Composite,
Composite
*, CompositeIteratorTraits
CompositeIterator
 
typedef
ConstBidirectionalIterator
< Composite, Composite,
Composite
*, CompositeIteratorTraits
CompositeConstIterator
 
typedef std::reverse_iterator
< CompositeIterator
CompositeReverseIterator
 
typedef std::reverse_iterator
< CompositeConstIterator
CompositeConstReverseIterator
 
enum  StampType { MODIFICATION = 1, SELECTION = 2, BOTH = 3 }
 
typedef UnaryPredicate< CompositeKernelPredicateType
 

Public Member Functions

bool operator== (const Nucleotide &nucleotide) const
 
bool operator!= (const Nucleotide &nucleotide) const
 
Constructors and Destructors
 Nucleotide ()
 Default constructor. More...
 
 Nucleotide (const Nucleotide &nucleotide, bool deep=true)
 Copy constructor. More...
 
 Nucleotide (const String &name, const String &id=BALL_NUCLEOTIDE_DEFAULT_ID, char insertion_code=BALL_NUCLEOTIDE_DEFAULT_INSERTION_CODE)
 Detailled constructor. More...
 
virtual ~Nucleotide ()
 Destructor. More...
 
virtual void clear ()
 Clears the nucleotides contents. More...
 
virtual void destroy ()
 Clears the nucleotides contents and removes it from all composite structures. More...
 
Persistence
void persistentWrite (PersistenceManager &pm, const char *name=0) const
 
void persistentRead (PersistenceManager &pm)
 
Assignment
void set (const Nucleotide &nucleotide, bool deep=true)
 
Nucleotideoperator= (const Nucleotide &nucleotide)
 
void get (Nucleotide &nucleotide, bool deep=true) const
 
void swap (Nucleotide &nucleotide)
 
Accessors
NucleicAcidgetNucleicAcid ()
 
const NucleicAcidgetNucleicAcid () const
 
void setID (const String &id)
 
const StringgetID () const
 
void setInsertionCode (char insertion_code)
 
char getInsertionCode () const
 
void prepend (Atom &atom)
 
void append (Atom &atom)
 
void insert (Atom &atom)
 
void insertBefore (Atom &atom, Composite &before)
 
void insertAfter (Atom &atom, Composite &after)
 
bool remove (Atom &atom)
 
void spliceBefore (Nucleotide &nucleotide)
 
void spliceAfter (Nucleotide &nucleotide)
 
void splice (Nucleotide &nucleotide)
 
Predicates
bool isTerminal () const
 
bool is3Prime () const
 
bool is5Prime () const
 
Debugging and Diagnostics
virtual bool isValid () const
 
virtual void dump (std::ostream &s=std::cout, Size depth=0) const
 
- Public Member Functions inherited from BALL::Fragment
bool operator== (const Fragment &fragment) const
 
bool operator!= (const Fragment &fragment) const
 
 Fragment ()
 
 Fragment (const Fragment &fragment, bool deep=true)
 
 Fragment (const String &name)
 
virtual ~Fragment ()
 
Fragmentoperator= (const Fragment &fragment)
 
- Public Member Functions inherited from BALL::AtomContainer
 AtomContainer ()
 
 AtomContainer (const AtomContainer &atom_container, bool deep=true)
 
 AtomContainer (const String &name)
 
virtual ~AtomContainer ()
 
void set (const AtomContainer &atom_container, bool deep=true)
 
AtomContaineroperator= (const AtomContainer &atom_container)
 
void get (AtomContainer &atom_container, bool deep=true) const
 
void swap (AtomContainer &atom_container)
 
bool operator== (const AtomContainer &atom_container) const
 
bool operator!= (const AtomContainer &atom_container) const
 
bool isSubAtomContainerOf (const AtomContainer &atom_container) const
 
bool isSuperAtomContainerOf (const AtomContainer &atom_container) const
 
void setName (const String &name)
 
const StringgetName () const
 
AtomContainergetSuperAtomContainer ()
 
const AtomContainergetSuperAtomContainer () const
 
AtomContainergetAtomContainer (Position position)
 
const AtomContainergetAtomContainer (Position position) const
 
AtomgetAtom (Position position)
 
const AtomgetAtom (Position position) const
 
AtomgetAtom (const String &name)
 
const AtomgetAtom (const String &name) const
 
Size countAtomContainers () const
 
Size countAtoms () const
 
Size countBonds () const
 
Size countInterBonds () const
 
Size countIntraBonds () const
 
void prepend (Atom &atom)
 
void append (Atom &atom)
 
void insert (Atom &atom)
 
void insertBefore (Atom &atom, Composite &before)
 
void insertAfter (Atom &atom, Composite &after)
 
bool remove (Atom &atom)
 
Size removeHavingProperty (BALL::Property p)
 
Size removeNotHavingProperty (BALL::Property p)
 
Size removeHavingProperty (const string &name)
 
Size removeNotHavingProperty (const string &name)
 
void prepend (AtomContainer &atom_container)
 
void append (AtomContainer &atom_container)
 
void insert (AtomContainer &atom_container)
 
void insertBefore (AtomContainer &atom_container, Composite &before)
 
void insertAfter (AtomContainer &atom_container, Composite &after)
 
void spliceBefore (AtomContainer &atom_container)
 
void spliceAfter (AtomContainer &atom_container)
 
void splice (AtomContainer &atom_container)
 
bool remove (AtomContainer &atom_container)
 
void destroyBonds ()
 
bool applyIntraBond (UnaryProcessor< Bond > &processor)
 Apply to all bonds connecting two atoms inside this AtomContainer. More...
 
bool applyInterBond (UnaryProcessor< Bond > &processor)
 Apply to all bonds connected to atoms outside this AtomContainer. More...
 
- Public Member Functions inherited from BALL::Composite
AncestorIterator beginAncestor ()
 
AncestorIterator endAncestor ()
 
AncestorConstIterator beginAncestor () const
 
AncestorConstIterator endAncestor () const
 
ChildCompositeIterator beginChildComposite ()
 
ChildCompositeIterator endChildComposite ()
 
ChildCompositeConstIterator beginChildComposite () const
 
ChildCompositeConstIterator endChildComposite () const
 
ChildCompositeReverseIterator rbeginChildComposite ()
 
ChildCompositeReverseIterator rendChildComposite ()
 
ChildCompositeConstReverseIterator rbeginChildComposite () const
 
ChildCompositeConstReverseIterator rendChildComposite () const
 
CompositeIterator beginComposite ()
 
CompositeIterator endComposite ()
 
CompositeConstIterator beginComposite () const
 
CompositeConstIterator endComposite () const
 
CompositeReverseIterator rbeginComposite ()
 
CompositeReverseIterator rendComposite ()
 
CompositeConstReverseIterator rbeginComposite () const
 
CompositeConstReverseIterator rendComposite () const
 
void deleteChildrenList_ (std::list< Composite * > &composites)
 
template<typename T >
BALL_INLINE bool apply (UnaryProcessor< T > &processor)
 
template<typename T >
BALL_INLINE T * getAncestor (const T &)
 
template<typename T >
BALL_INLINE const T * getAncestor (const T &) const
 
template<typename T >
BALL_INLINE T * getPrevious (const T &)
 
template<typename T >
BALL_INLINE const T * getPrevious (const T &dummy) const
 
template<typename T >
BALL_INLINE T * getNext (const T &)
 
template<typename T >
BALL_INLINE const T * getNext (const T &dummy) const
 
template<typename T >
BALL_INLINE bool hasAncestor (const T &dummy) const
 
 Composite ()
 
 Composite (const Composite &composite, bool deep=true)
 
virtual ~Composite ()
 
void destroy (bool virtual_destroy)
 
void * clone (Composite &root) const
 
bool operator== (const Composite &composite) const
 
bool operator!= (const Composite &composite) const
 
bool isEmpty () const
 
bool isRoot () const
 
bool isRootOf (const Composite &composite) const
 
bool isInterior () const
 
bool hasChild () const
 
bool isChildOf (const Composite &composite) const
 
bool isFirstChild () const
 
bool isFirstChildOf (const Composite &composite) const
 
bool isLastChild () const
 
bool isLastChildOf (const Composite &composite) const
 
bool hasParent () const
 
bool isParentOf (const Composite &composite) const
 
bool hasSibling () const
 
bool isSiblingOf (const Composite &composite) const
 
bool hasPreviousSibling () const
 
bool isPreviousSiblingOf (const Composite &composite) const
 
bool hasNextSibling () const
 
bool isNextSiblingOf (const Composite &composite) const
 
bool isDescendantOf (const Composite &composite) const
 
template<typename T >
bool hasAncestor (const T &dummy) const
 
bool isAncestorOf (const Composite &composite) const
 
bool isRelatedWith (const Composite &composite) const
 
bool isHomomorph (const Composite &composite) const
 
bool containsSelection () const
 
void host (Visitor< Composite > &visitor)
 
template<typename T >
bool applyAncestor (UnaryProcessor< T > &processor)
 
template<typename T >
bool applyChild (UnaryProcessor< T > &processor)
 
template<typename T >
bool applyDescendantPreorder (UnaryProcessor< T > &processor)
 
template<typename T >
bool applyDescendantPostorder (UnaryProcessor< T > &processor)
 
template<typename T >
bool applyDescendant (UnaryProcessor< T > &processor)
 
template<typename T >
bool applyPreorder (UnaryProcessor< T > &processor)
 
template<typename T >
bool applyPostorder (UnaryProcessor< T > &processor)
 
template<typename T >
bool apply (UnaryProcessor< T > &processor)
 
template<typename T >
bool applyLevel (UnaryProcessor< T > &processor, long level)
 
void set (const Composite &composite, bool deep=true)
 
Compositeoperator= (const Composite &composite)
 
void get (Composite &composite, bool deep=true) const
 
Size getDegree () const
 
Size count (const KernelPredicateType &predicate) const
 
Size countDescendants () const
 
Size getPathLength (const Composite &composite) const
 
Size getDepth () const
 
Size getHeight () const
 
CompositegetRoot ()
 
const CompositegetRoot () const
 
CompositegetLowestCommonAncestor (const Composite &composite)
 
const CompositegetLowestCommonAncestor (const Composite &composite) const
 
template<typename T >
T * getAncestor (const T &)
 
template<typename T >
const T * getAncestor (const T &) const
 
template<typename T >
T * getPrevious (const T &)
 
template<typename T >
const T * getPrevious (const T &dummy) const
 
template<typename T >
T * getNext (const T &)
 
template<typename T >
const T * getNext (const T &dummy) const
 
CompositegetParent ()
 
const CompositegetParent () const
 
CompositegetChild (Index index)
 
const CompositegetChild (Index index) const
 
CompositegetSibling (Index index)
 
const CompositegetSibling (Index index) const
 
CompositegetFirstChild ()
 
const CompositegetFirstChild () const
 
CompositegetLastChild ()
 
const CompositegetLastChild () const
 
const PreciseTimegetModificationTime () const
 
const PreciseTimegetSelectionTime () const
 
void stamp (StampType stamp=BOTH)
 
void prependChild (Composite &composite)
 
void appendChild (Composite &composite)
 
void insertBefore (Composite &composite)
 
void insertAfter (Composite &composite)
 
void spliceBefore (Composite &composite)
 
void spliceAfter (Composite &composite)
 
void splice (Composite &composite)
 
bool removeChild (Composite &child)
 
Size removeSelected ()
 
Size removeUnselected ()
 
void replace (Composite &composite)
 
void swap (Composite &composite)
 
virtual void select ()
 
virtual void deselect ()
 
- Public Member Functions inherited from BALL::PersistentObject
 PersistentObject ()
 
virtual ~PersistentObject ()
 
PersistenceManageroperator>> (PersistenceManager &pm) const
 
virtual void finalize ()
 
- Public Member Functions inherited from BALL::Object
 Object ()
 Default constructor. More...
 
 Object (const Object &object)
 Copy constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
const Objectoperator= (const Object &)
 
bool operator== (const Object &object) const
 
bool operator!= (const Object &object) const
 
bool operator< (const Object &object) const
 
bool operator<= (const Object &object) const
 
bool operator>= (const Object &object) const
 
bool operator> (const Object &object) const
 
int compare (const Object &object) const
 
virtual void dump (::std::ostream &s=std::cout, Size depth=0) const
 
Handle getHandle () const
 
- Public Member Functions inherited from BALL::AutoDeletable
virtual ~AutoDeletable ()
 
void * operator new (size_t size)
 
void operator delete (void *ptr)
 
void * operator new (size_t size, void *ptr)
 
void operator delete (void *ptr, void *)
 
bool isAutoDeletable () const
 
void setAutoDeletable (bool enable)
 
- Public Member Functions inherited from BALL::Selectable
 Selectable ()
 
 Selectable (const Selectable &selectable, bool deep=true)
 
virtual ~Selectable ()
 
void set (const Selectable &selectable, bool deep=true)
 
const Selectableoperator= (const Selectable &selectable)
 
void get (Selectable &selectable, bool deep=true) const
 
void swap (Selectable &selectable)
 
virtual void setSelected (bool selected)
 
bool isSelected () const
 
bool operator== (const Selectable &selectable) const
 
bool operator!= (const Selectable &selectable) const
 
void write (PersistenceManager &pm) const
 
bool read (PersistenceManager &pm)
 
virtual void dump (::std::ostream &s=std::cout, Size depth=0) const
 
- Public Member Functions inherited from BALL::PropertyManager
BALL_INLINE PropertyManager ()
 Default constructor. More...
 
BALL_INLINE PropertyManager (const PropertyManager &property_manager)
 Copy constructor. More...
 
virtual ~PropertyManager ()
 Destructor. More...
 
void set (const PropertyManager &property_manager)
 
const PropertyManageroperator= (const PropertyManager &property_manager)
 
void get (PropertyManager &property_manager) const
 
void swap (PropertyManager &property_manager)
 
BitVectorgetBitVector ()
 
const BitVectorgetBitVector () const
 
 operator BitVector & ()
 
void setProperty (Property property)
 
void clearProperty (Property property)
 
void toggleProperty (Property property)
 
Size countProperties () const
 
const NamedPropertygetNamedProperty (Position index) const
 
NamedPropertygetNamedProperty (Position index)
 
void setProperty (const NamedProperty &property)
 
void setProperty (const string &name)
 
void setProperty (const string &name, bool value)
 
void setProperty (const string &name, int value)
 
void setProperty (const string &name, unsigned int value)
 
void setProperty (const string &name, float value)
 
void setProperty (const string &name, double value)
 
void setProperty (const string &name, const string &value)
 
void setProperty (const string &name, const PersistentObject &value)
 
const NamedPropertygetProperty (const string &name) const
 
NamedPropertyIterator beginNamedProperty ()
 
NamedPropertyIterator endNamedProperty ()
 
void clearProperty (const string &name)
 
Size countNamedProperties () const
 
bool hasProperty (Property property) const
 Query for an unnamed property. More...
 
bool hasProperty (const string &name) const
 Query for a named property. More...
 
bool operator== (const PropertyManager &pm) const
 
bool operator!= (const PropertyManager &pm) const
 Inequality operator. More...
 
void write (PersistenceManager &pm) const
 Persistent stream writing. More...
 
bool read (PersistenceManager &pm)
 Persistent stream reading. More...
 
bool isValid () const
 
void dump (std::ostream &s=std::cout, Size depth=0) const
 

Private Member Functions

AtomContainergetAtomContainer (Position position)
 
const AtomContainergetAtomContainer (Position position) const
 
Size countAtomContainers () const
 
void prepend (AtomContainer &atom_container)
 
void append (AtomContainer &atom_container)
 
void insert (AtomContainer &atom_container)
 
void insertBefore (AtomContainer &atom_container, Composite &composite)
 
void insertAfter (AtomContainer &atom_container, Composite &composite)
 
void spliceBefore (AtomContainer &atom_container)
 
void spliceAfter (AtomContainer &base_ragment)
 
void splice (AtomContainer &AtomContainer)
 
bool remove (AtomContainer &AtomContainer)
 
bool isSuperAtomContainerOf (const AtomContainer &atom_container) const
 

Private Attributes

String id_
 
char insertion_code_
 

Additional Inherited Members

- Static Public Member Functions inherited from BALL::Composite
static bool insertParent (Composite &parent, Composite &first, Composite &last, bool destroy_parent=true)
 
- Static Public Member Functions inherited from BALL::Object
static Handle getNextHandle ()
 
static Handle getNewHandle ()
 
- Static Public Member Functions inherited from BALL::AutoDeletable
static void clearLastPtr ()
 
- Static Public Attributes inherited from BALL::Composite
static UnaryProcessor< CompositeDEFAULT_PROCESSOR
 
static KernelPredicateType DEFAULT_UNARY_PREDICATE
 
- Protected Member Functions inherited from BALL::AutoDeletable
 AutoDeletable ()
 
 AutoDeletable (const AutoDeletable &auto_deletable, bool deep=false)
 
- Protected Attributes inherited from BALL::Selectable
bool selected_
 

Detailed Description

Nucleotide class. This class is used to represent nucleotides within an NucleicAcid object.

Definition at line 35 of file nucleotide.h.

Member Enumeration Documentation

Enumerator
PROPERTY__5_PRIME 
PROPERTY__3_PRIME 
PROPERTY__NUCLEOTIDE 
NUMBER_OF_PROPERTIES 

Definition at line 47 of file nucleotide.h.

Constructor & Destructor Documentation

BALL::Nucleotide::Nucleotide ( )

Default constructor.

BALL::Nucleotide::Nucleotide ( const Nucleotide nucleotide,
bool  deep = true 
)

Copy constructor.

BALL::Nucleotide::Nucleotide ( const String name,
const String id = BALL_NUCLEOTIDE_DEFAULT_ID,
char  insertion_code = BALL_NUCLEOTIDE_DEFAULT_INSERTION_CODE 
)

Detailled constructor.

virtual BALL::Nucleotide::~Nucleotide ( )
virtual

Destructor.

Member Function Documentation

void BALL::Nucleotide::append ( Atom atom)

Append an atom after the last position.

Parameters
atomthe atom to append
void BALL::Nucleotide::append ( AtomContainer atom_container)
private
virtual void BALL::Nucleotide::clear ( )
virtual

Clears the nucleotides contents.

Reimplemented from BALL::AtomContainer.

Size BALL::Nucleotide::countAtomContainers ( ) const
private
virtual void BALL::Nucleotide::destroy ( )
virtual

Clears the nucleotides contents and removes it from all composite structures.

Reimplemented from BALL::AtomContainer.

virtual void BALL::Nucleotide::dump ( std::ostream &  s = std::cout,
Size  depth = 0 
) const
virtual

Internal state dump. Dump the current internal state of this instance to the output ostream s with dumping depth depth .

Parameters
soutput stream where to output the internal state of this instance nucleotide
depththe dumping depth

Reimplemented from BALL::Fragment.

void BALL::Nucleotide::get ( Nucleotide nucleotide,
bool  deep = true 
) const

Copy this instance to nucleotide . The assignment is either deep or shallow (default).

Parameters
nucleotidethe nucleotide to be assigned to
See Also
nucleotide::set
AtomContainer* BALL::Nucleotide::getAtomContainer ( Position  position)
private
const AtomContainer* BALL::Nucleotide::getAtomContainer ( Position  position) const
private
const String& BALL::Nucleotide::getID ( ) const

Retrieve the ID of the nucleotide.

Returns
String the ID (constant)
char BALL::Nucleotide::getInsertionCode ( ) const

Retrieve the insertion code of the nucleotide.

Returns
String the insertion code (constant)
NucleicAcid* BALL::Nucleotide::getNucleicAcid ( )

Get a pointer to the parent NucleicAcid. The pointer is 0 if this instance nucleotide does not have a parent NucleicAcid.

Returns
NucleicAcid* - mutable pointer to the parent NucleicAcid
const NucleicAcid* BALL::Nucleotide::getNucleicAcid ( ) const

Get a pointer to the parent NucleicAcid. The pointer is 0 if this instance nucleotide does not have a parent NucleicAcid.

Returns
NucleicAcid* - constant pointer to the parent NucleicAcid
void BALL::Nucleotide::insert ( Atom atom)

Insert an atom after the last position.

Parameters
atomthe atom to insert
void BALL::Nucleotide::insert ( AtomContainer atom_container)
private
void BALL::Nucleotide::insertAfter ( Atom atom,
Composite after 
)

Insert an atom after a given Composite object.

Parameters
atomthe atom to insert
afterthe Composite object to insert after
void BALL::Nucleotide::insertAfter ( AtomContainer atom_container,
Composite composite 
)
private
void BALL::Nucleotide::insertBefore ( Atom atom,
Composite before 
)

Insert an atom before a given Composite object.

Parameters
atomthe atom to insert
beforethe Composite object to insert before
void BALL::Nucleotide::insertBefore ( AtomContainer atom_container,
Composite composite 
)
private
bool BALL::Nucleotide::is3Prime ( ) const

Test if this instance nucleotide is 3-prime. Returns true, if this instance is the first nucleotide in its parent NucleicAcid.

Returns
bool
bool BALL::Nucleotide::is5Prime ( ) const

Test if this instance nucleotide is 5-prime. Returns true, if this instance is the last nucleotide in its parent NucleicAcid.

Returns
bool
bool BALL::Nucleotide::isSuperAtomContainerOf ( const AtomContainer atom_container) const
private
bool BALL::Nucleotide::isTerminal ( ) const

Test if this instance nucleotide is terminal. Returns true, if this instance is the first or last nucleotide in its parent NucleicAcid.

Returns
bool
virtual bool BALL::Nucleotide::isValid ( ) const
virtual

Internal state and consistency self-validation.

Returns
bool - true if the internal state of this instance nucleotide is correct (self-validated) and consistent, false otherwise

Reimplemented from BALL::AtomContainer.

bool BALL::Nucleotide::operator!= ( const Nucleotide nucleotide) const

Inequality operator

See Also
operator ==
Nucleotide& BALL::Nucleotide::operator= ( const Nucleotide nucleotide)

Assignment operator. The assignment is either deep or shallow (default).

Parameters
nucleotidethe nucleotide to be copied (cloned)
Returns
nucleotide& - this instance nucleotide
See Also
nucleotide::set
bool BALL::Nucleotide::operator== ( const Nucleotide nucleotide) const

Equality operator. Two nucleotides are equal if they have the same handle.

See Also
Object::operator ==.
void BALL::Nucleotide::persistentRead ( PersistenceManager pm)
virtual

Reads a Nucleotide object from a persistent stream.

Parameters
pmthe persistence manager

Reimplemented from BALL::Fragment.

void BALL::Nucleotide::persistentWrite ( PersistenceManager pm,
const char *  name = 0 
) const
virtual

Writes a Nucleotide object to a persistent stream.

Parameters
pmthe persistence manager

Reimplemented from BALL::Fragment.

void BALL::Nucleotide::prepend ( Atom atom)

Prepend an atom at position 0.

Parameters
atomthe atom to prepend
void BALL::Nucleotide::prepend ( AtomContainer atom_container)
private
bool BALL::Nucleotide::remove ( Atom atom)

Remove an atom.

Parameters
atomthe atom to remove
bool BALL::Nucleotide::remove ( AtomContainer AtomContainer)
private
void BALL::Nucleotide::set ( const Nucleotide nucleotide,
bool  deep = true 
)

Assignment with cloning facility. The assignment is either deep or shallow (default).

Parameters
nucleotidethe nucleotide to be copied (cloned)
deepmake a deep (=true) or shallow (=false) copy
void BALL::Nucleotide::setID ( const String id)

Set the ID of the nucleotide.

Parameters
idthe new ID
void BALL::Nucleotide::setInsertionCode ( char  insertion_code)

Set the insertion code of the nucleotide.

Parameters
insertion_codethe new insertion code
void BALL::Nucleotide::splice ( Nucleotide nucleotide)

Move the children of nucleotide into this instance. The children are inserted using spliceBefore .

void BALL::Nucleotide::splice ( AtomContainer AtomContainer)
private
void BALL::Nucleotide::spliceAfter ( Nucleotide nucleotide)

Cut all children of nucleotide and append them after the children of this instance.

Parameters
nucleotidethe nucleotide to access
void BALL::Nucleotide::spliceAfter ( AtomContainer base_ragment)
private
void BALL::Nucleotide::spliceBefore ( Nucleotide nucleotide)

Cut all children of nucleotide and prepend them before the children of this instance.

Parameters
nucleotidethe nucleotide to access
void BALL::Nucleotide::spliceBefore ( AtomContainer atom_container)
private
void BALL::Nucleotide::swap ( Nucleotide nucleotide)

Swapping of instaces of nucleotide.

Parameters
nucleotidethe instance of nucleotide to swap with

Member Data Documentation

String BALL::Nucleotide::id_
private

Definition at line 305 of file nucleotide.h.

char BALL::Nucleotide::insertion_code_
private

Definition at line 307 of file nucleotide.h.