cee::ug::HitItemCollection Class Reference

A collection of HitItem instances. More...

Public Member Functions

 HitItemCollection ()
 Constructs an empty hititem collection. More...
 
 HitItemCollection (const HitItemCollection &other)
 Constructs a hititem collection as a copy of other. More...
 
HitItemCollectionoperator= (const HitItemCollection &other)
 Returns true if this equals other. More...
 
size_t count () const
 Returns the number of items in the collection. More...
 
HitItem item (size_t index) const
 Returns the HitItem at the given index. More...
 
void add (const HitItem &item)
 Adds the given HitItem to the collection and returns the new number of items. More...
 
HitItemCollection firstItems (double equalItemThreshold) const
 Returns all the HitItem instance that are at minimal distance. More...
 

Detailed Description

A collection of HitItem instances.

See also
HitItem
UnstructGridModel

Constructor & Destructor Documentation

cee::ug::HitItemCollection::HitItemCollection ( )

Constructs an empty hititem collection.

cee::ug::HitItemCollection::HitItemCollection ( const HitItemCollection other)

Constructs a hititem collection as a copy of other.

Member Function Documentation

void cee::ug::HitItemCollection::add ( const HitItem item)

Adds the given HitItem to the collection and returns the new number of items.

size_t cee::ug::HitItemCollection::count ( ) const

Returns the number of items in the collection.

HitItemCollection cee::ug::HitItemCollection::firstItems ( double  equalItemThreshold) const

Returns all the HitItem instance that are at minimal distance.

Two items are considered equal when their distance differs by no more than the given equalItemThreshold

HitItem cee::ug::HitItemCollection::item ( size_t  index) const

Returns the HitItem at the given index.

HitItemCollection & cee::ug::HitItemCollection::operator= ( const HitItemCollection other)

Returns true if this equals other.