SiteListInterface Class Reference

#include <SiteListInterface.hpp>

Inheritance diagram for SiteListInterface:

Public Member Functions
virtual	~SiteListInterface ()
virtual int	numSites () const =0
virtual Position	sitePosition (int index) const =0

Protected Member Functions
	SiteListInterface ()

Detailed Description

SiteListInterface is a pure interface that provides the positions of a set of sites. It is implemented by density distributions (such as geometries or transfer media) that are defined through a set of particles or cells. The locations of these entities can serve, for example, as a hint for building an appropriate spatial grid.

Constructor & Destructor Documentation

SiteListInterface()

SiteListInterface::SiteListInterface ( )

inlineprotected

The empty constructor for the interface.

~SiteListInterface()

virtual SiteListInterface::~SiteListInterface ( )

inlinevirtual

The empty destructor for the interface.

Member Function Documentation

numSites()

virtual int SiteListInterface::numSites ( ) const

pure virtual

This function returns the number of sites in the list.

Implemented in ImportedGeometry, and ImportedMedium.

sitePosition()

virtual Position SiteListInterface::sitePosition ( int  index ) const

pure virtual

This function returns the coordinates of the site with the specified zero-based index. If the index is out of range, the behavior is undefined.

Implemented in ImportedGeometry, and ImportedMedium.

---

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

• SiteListInterface.hpp