kalzium

Avogadro::IDList

Avogadro::IDList Class Reference

#include <idlist.h>

Detailed Description

Class which set of Primitives.

Author:: Donald Ephraim Curtis

The IDList class is designed to hold a set of Primitive objects and keep them organized by type allowing groups of them to be retrieved in constant time.

Definition at line 48 of file src/idlist.h.


Public Member Functions
void	append (Primitive *p)
void	clear ()
bool	contains (const Primitive *p) const
int	count () const
int	count (Primitive::Type type) const
	IDList (const PrimitiveList &other)
	IDList (const QList< Primitive * > &other)
	IDList (const IDList &other)
	IDList ()
bool	isEmpty () const
IDList &	operator= (const PrimitiveList &other)
IDList &	operator= (const QList< Primitive * > &other)
IDList &	operator= (const IDList &other)
void	removeAll (Primitive *p)
int	size () const
QList< unsigned long >	subList (Primitive::Type type) const
	~IDList ()

Constructor & Destructor Documentation

Avogadro::IDList::IDList ( )

Constructor(s).

Definition at line 40 of file idlist.cpp.

Avogadro::IDList::IDList ( const IDList & other )

Definition at line 44 of file idlist.cpp.

Avogadro::IDList::IDList ( const QList< Primitive * > & other )

Definition at line 51 of file idlist.cpp.

Avogadro::IDList::IDList ( const PrimitiveList & other )

Definition at line 60 of file idlist.cpp.

Avogadro::IDList::~IDList ( )

Deconstructor.

Definition at line 102 of file idlist.cpp.

Member Function Documentation

void Avogadro::IDList::append ( Primitive * p )

Add a primitive to the queue.

Parameters:

primitive to add

Definition at line 120 of file idlist.cpp.

void Avogadro::IDList::clear ( )

Removes every primitive from the queue.

Definition at line 153 of file idlist.cpp.

bool Avogadro::IDList::contains ( const Primitive * p ) const

Parameters:

the primitive to check if it is in any list

Returns:: true or false depending on whether p is in this list

Definition at line 116 of file idlist.cpp.

int Avogadro::IDList::count ( ) const

effectively the same as size()

See also:: size()

Definition at line 139 of file idlist.cpp.

int Avogadro::IDList::count ( Primitive::Type type ) const

Parameters:

type

the type of primitives we're interested in

Returns:: the number of primitives for the given type

Definition at line 143 of file idlist.cpp.

bool Avogadro::IDList::isEmpty ( ) const

Returns:: !size()

Definition at line 134 of file idlist.cpp.

IDList & Avogadro::IDList::operator= ( const PrimitiveList & other )

Definition at line 90 of file idlist.cpp.

IDList & Avogadro::IDList::operator= ( const QList< Primitive * > & other )

Definition at line 78 of file idlist.cpp.

IDList & Avogadro::IDList::operator= ( const IDList & other )

Definition at line 69 of file idlist.cpp.

void Avogadro::IDList::removeAll ( Primitive * p )

Remove a primitive from the queue.

If the parameter does not exist in the queue, nothing is removed.

Parameters:

primitive to remove

Definition at line 125 of file idlist.cpp.

int Avogadro::IDList::size ( ) const

Returns:: the total number of primitives in this queue

Definition at line 130 of file idlist.cpp.

QList< unsigned long > Avogadro::IDList::subList ( Primitive::Type type ) const

Returns a list of primitives for a given type.

Parameters:

type

the type of primitives to retrieve, one of Primitive::Type

Returns:: a QList of pointers to Primitive objects

Definition at line 106 of file idlist.cpp.

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

kalzium

Avogadro::IDList Class Reference

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation

kalzium

kdeedu