A event-driven SymbolList object. More...

#include <Bpp/Seq/SymbolList.h>

Inheritance diagram for bpp::EdSymbolList:

Collaboration diagram for bpp::EdSymbolList:

Public Member Functions
	EdSymbolList (const Alphabet *alpha)
	Build a new void BasicSymbolList object with the specified alphabet. More...

	EdSymbolList (const std::vector< std::string > &list, const Alphabet *alpha) throw (BadCharException)
	Build a new BasicSymbolList object with the specified alphabet. The content of the site is initialized from a vector of characters. More...

	EdSymbolList (const std::vector< int > &list, const Alphabet *alpha) throw (BadIntException)
	Build a new BasicSymbolList object with the specified alphabet. The content of the site is initialized from a vector of integers. More...

	EdSymbolList (const SymbolList &list)
	The generic copy constructor. More...

	EdSymbolList (const EdSymbolList &list)
	The copy constructor. More...

EdSymbolList &	operator= (const SymbolList &list)
	The generic assignment operator. More...

EdSymbolList &	operator= (const EdSymbolList &list)
	The assignment operator. More...

virtual	~EdSymbolList ()

virtual const Alphabet *	getAlphabet () const
	Get the alphabet associated to the list. More...

virtual size_t	size () const
	Get the number of elements in the list. More...

virtual const std::vector< int > &	getContent () const
	Get the whole content of the list as a vector of int. More...

virtual void	setContent (const std::vector< int > &list) throw (BadIntException)
	Set the whole content of the list. More...

virtual void	setContent (const std::vector< std::string > &list) throw (BadCharException)
	Set the whole content of the list. More...

virtual std::string	toString () const
	Convert the list as a string. More...

virtual void	addElement (const std::string &c) throw (BadCharException)
	Add a character to the end of the list. More...

virtual void	addElement (size_t pos, const std::string &c) throw (BadCharException, IndexOutOfBoundsException)
	Add a character at a certain position in the list. More...

virtual void	setElement (size_t pos, const std::string &c) throw (BadCharException, IndexOutOfBoundsException)
	Set the element at position 'pos' to character 'c'. More...

virtual void	deleteElement (size_t pos) throw (IndexOutOfBoundsException)
	Delete the element at position 'pos'. More...

virtual void	deleteElements (size_t pos, size_t len) throw (IndexOutOfBoundsException)
	Delete the elements at position 'pos'. More...

virtual std::string	getChar (size_t pos) const throw (IndexOutOfBoundsException)
	Get the element at position 'pos' as a character. More...

virtual void	addElement (int v) throw (BadIntException)
	Add a character to the end of the list. More...

virtual void	addElement (size_t pos, int v) throw (BadIntException, IndexOutOfBoundsException)
	Add a character at a certain position in the list. More...

virtual void	setElement (size_t pos, int v) throw (BadIntException, IndexOutOfBoundsException)
	Set the element at position 'pos' to character 'v'. More...

virtual int	getValue (size_t pos) const throw (IndexOutOfBoundsException)
	Get the element at position 'pos' as an int. More...

virtual const int &	operator[] (size_t i) const
	Operator [] overloaded for quick access to a character in list. More...

virtual int &	operator[] (size_t i)
	Operator [] overloaded for quick access to a character in list. More...

virtual void	shuffle ()
	Randomly shuffle the content of the list, with linear complexity. More...

The Clonable interface
EdSymbolList *	clone () const

Protected Member Functions
void	propagateEvents (bool yn)

bool	propagateEvents () const

Protected Attributes
std::vector< int >	content_
	The list content. More...

std::vector< SymbolListListener * >	listeners_
	Contains the listeners. More...

Private Attributes
const Alphabet *	alphabet_
	The Alphabet attribute must be initialized in constructor and then can never be changed. More...

bool	propagateEvents_

Events handling
virtual size_t	getNumberOfListeners () const

virtual const SymbolListListener &	getListener (size_t i) const

virtual SymbolListListener &	getListener (size_t i)

virtual void	addSymbolListListener (SymbolListListener *listener)

virtual void	removeSymbolListListener (SymbolListListener *listener)

virtual void	beforeSequenceChanged (const SymbolListEditionEvent &event)

virtual void	afterSequenceChanged (const SymbolListEditionEvent &event)

virtual void	beforeSequenceInserted (const SymbolListInsertionEvent &event)

virtual void	afterSequenceInserted (const SymbolListInsertionEvent &event)

virtual void	beforeSequenceDeleted (const SymbolListDeletionEvent &event)

virtual void	afterSequenceDeleted (const SymbolListDeletionEvent &event)

virtual void	beforeSequenceSubstituted (const SymbolListSubstitutionEvent &event)

virtual void	afterSequenceSubstituted (const SymbolListSubstitutionEvent &event)

void	fireBeforeSequenceChanged (const SymbolListEditionEvent &event)

void	fireAfterSequenceChanged (const SymbolListEditionEvent &event)

void	fireBeforeSequenceInserted (const SymbolListInsertionEvent &event)

void	fireAfterSequenceInserted (const SymbolListInsertionEvent &event)

void	fireBeforeSequenceDeleted (const SymbolListDeletionEvent &event)

void	fireAfterSequenceDeleted (const SymbolListDeletionEvent &event)

void	fireBeforeSequenceSubstituted (const SymbolListSubstitutionEvent &event)

void	fireAfterSequenceSubstituted (const SymbolListSubstitutionEvent &event)

Detailed Description

A event-driven SymbolList object.

This is a general purpose container, containing an ordered list of states(= letters). The states that allowed to be present in the list are defined by an alphabet object, which is passed to the list constructor by a pointer.

For programming convenience, the states are stored as integers, but the translation toward and from a char description is easily performed with the Alphabet classes.

See Also: Alphabet

Definition at line 500 of file SymbolList.h.

Constructor & Destructor Documentation

bpp::EdSymbolList::EdSymbolList ( const Alphabet * alpha )

inline

Build a new void BasicSymbolList object with the specified alphabet.

Parameters

alpha The alphabet to use.

Definition at line 532 of file SymbolList.h.

Referenced by clone().

EdSymbolList::EdSymbolList	(	const std::vector< std::string > &	list,
		const Alphabet *	alpha
	)		throw (BadCharException)

Build a new BasicSymbolList object with the specified alphabet. The content of the site is initialized from a vector of characters.

Parameters

list	The content of the site.
alpha	The alphabet to use.

Exceptions

BadCharException If the content does not match the specified alphabet.

Definition at line 224 of file SymbolList.cpp.

EdSymbolList::EdSymbolList	(	const std::vector< int > &	list,
		const Alphabet *	alpha
	)		throw (BadIntException)

Build a new BasicSymbolList object with the specified alphabet. The content of the site is initialized from a vector of integers.

Parameters

list	The content of the site.
alpha	The alphabet to use.

Exceptions

BadIntException If the content does not match the specified alphabet.

Definition at line 230 of file SymbolList.cpp.

EdSymbolList::EdSymbolList ( const SymbolList & list )

The generic copy constructor.

Definition at line 238 of file SymbolList.cpp.

EdSymbolList::EdSymbolList ( const EdSymbolList & list )

The copy constructor.

Definition at line 241 of file SymbolList.cpp.

References listeners_, listeners_, listeners_, and listeners_.

virtual bpp::EdSymbolList::~EdSymbolList ( )

inlinevirtual

Definition at line 588 of file SymbolList.h.

References listeners_, listeners_, listeners_, and listeners_.

Member Function Documentation

void EdSymbolList::addElement ( const std::string & c ) throw (BadCharException)

virtual

Add a character to the end of the list.

Parameters

c	The character to add, given as a string.

pos	The postion where to insert the element.
c	The character to add, given as a string.

pos	The postion where to insert the element.
v	The character to add, given as an int.

pos	The position of the first element to delete.
len	The length of the region to delete.

pos	The position of the character to set.
c	The value of the element, given as a string.

pos	The position of the character to set.
v	The value of the element, given as an int.

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Events handling

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation