• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdeedu
  • Sitemap
  • Contact Us
 

kalzium

Avogadro::PrimitiveList

Avogadro::PrimitiveList Class Reference

#include <primitivelist.h>

List of all members.


Detailed Description

Class which set of Primitives.

Author:
Donald Ephraim Curtis
The PrimitiveList 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 47 of file src/primitivelist.h.


Public Member Functions

void append (Primitive *p)
const_iterator begin () const
void clear ()
bool contains (const Primitive *p) const
int count () const
int count (Primitive::Type type) const
const_iterator end () const
bool isEmpty () const
QList< Primitive * > list () const
PrimitiveList & operator= (const QList< Primitive * > &other)
PrimitiveList & operator= (const PrimitiveList &other)
 PrimitiveList (const QList< Primitive * > &other)
 PrimitiveList (const PrimitiveList &other)
 PrimitiveList ()
void removeAll (Primitive *p)
int size () const
QList< Primitive * > subList (Primitive::Type type) const
 ~PrimitiveList ()

Classes

class  const_iterator

Constructor & Destructor Documentation

Avogadro::PrimitiveList::PrimitiveList (  ) 

Constructor(s).

Definition at line 40 of file primitivelist.cpp.

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

Definition at line 44 of file primitivelist.cpp.

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

Definition at line 51 of file primitivelist.cpp.

Avogadro::PrimitiveList::~PrimitiveList (  ) 

Deconstructor.

Definition at line 81 of file primitivelist.cpp.


Member Function Documentation

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

Add a primitive to the queue.

Parameters:
p primitive to add

Definition at line 111 of file primitivelist.cpp.

PrimitiveList::const_iterator Avogadro::PrimitiveList::begin (  )  const

Definition at line 151 of file primitivelist.cpp.

void Avogadro::PrimitiveList::clear (  ) 

Removes every primitive from the queue.

Definition at line 144 of file primitivelist.cpp.

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

Parameters:
p 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 105 of file primitivelist.cpp.

int Avogadro::PrimitiveList::count (  )  const

effectively the same as size()

See also:
size()

Definition at line 130 of file primitivelist.cpp.

int Avogadro::PrimitiveList::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 134 of file primitivelist.cpp.

PrimitiveList::const_iterator Avogadro::PrimitiveList::end (  )  const

Definition at line 156 of file primitivelist.cpp.

bool Avogadro::PrimitiveList::isEmpty (  )  const

Returns:
!size()

Definition at line 125 of file primitivelist.cpp.

QList< Primitive * > Avogadro::PrimitiveList::list (  )  const

Returns a list of all primitives of all types.

Returns:
a QList of pointers to Primitive objects

Definition at line 95 of file primitivelist.cpp.

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

Definition at line 69 of file primitivelist.cpp.

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

Definition at line 60 of file primitivelist.cpp.

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

Remove a primitive from the queue.

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

Parameters:
p primitive to remove

Definition at line 116 of file primitivelist.cpp.

int Avogadro::PrimitiveList::size (  )  const

Returns:
the total number of primitives in this queue

Definition at line 121 of file primitivelist.cpp.

QList< Primitive * > Avogadro::PrimitiveList::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 85 of file primitivelist.cpp.


The documentation for this class was generated from the following files:
  • src/primitivelist.h
  • primitivelist.cpp

kalzium

Skip menu "kalzium"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdeedu

Skip menu "kdeedu"
  • kalzium
  • kanagram
  • kig
  •   lib
  • klettres
  • kstars
  • libkdeedu
  •   keduvocdocument
  •   docs
  •   src
  • parley
  •   stepcore
Generated for kdeedu by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal