cee::ug::DataElementSetItem Class Reference

This class identifies an element within an UnstructGrid model and is used as an item in a DataElementSet. More...

Public Member Functions

 DataElementSetItem ()
 Constructs and empty item. More...
 
 DataElementSetItem (int geometryId, int partId, size_t elementIndex)
 Constructs a set item with the given data. More...
 
 DataElementSetItem (const DataElementSetItem &other)
 Copy constructor. More...
 
DataElementSetItemoperator= (const DataElementSetItem &other)
 Assignment operator. More...
 
bool operator== (const DataElementSetItem &rhs) const
 Returns true if this set item is equal to the given rhs item. More...
 
bool operator!= (const DataElementSetItem &rhs) const
 Returns true if this set item is not equal to the given rhs item. More...
 
int geometryId () const
 Returns the geometry id of this set item. More...
 
void setGeometryId (int geometryId)
 Sets the geometry id of this set item. More...
 
int partId () const
 Returns the part id of this set item. More...
 
void setPartId (int partId)
 Sets the part id of this set item. More...
 
size_t elementIndex () const
 Returns the element index or the set item. More...
 
void setElementIndex (size_t elementIndex)
 Sets the element index of the set item. More...
 

Detailed Description

This class identifies an element within an UnstructGrid model and is used as an item in a DataElementSet.

An element is uniquely identified within a UnstructGrid DataSource by three numbers:

See also
DataElementSet

Constructor & Destructor Documentation

cee::ug::DataElementSetItem::DataElementSetItem ( )

Constructs and empty item.

cee::ug::DataElementSetItem::DataElementSetItem ( int  geometryId,
int  partId,
size_t  elementIndex 
)

Constructs a set item with the given data.

cee::ug::DataElementSetItem::DataElementSetItem ( const DataElementSetItem other)

Copy constructor.

Member Function Documentation

size_t cee::ug::DataElementSetItem::elementIndex ( ) const

Returns the element index or the set item.

int cee::ug::DataElementSetItem::geometryId ( ) const

Returns the geometry id of this set item.

See also
DataGeometry::id
bool cee::ug::DataElementSetItem::operator!= ( const DataElementSetItem rhs) const

Returns true if this set item is not equal to the given rhs item.

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

Assignment operator.

bool cee::ug::DataElementSetItem::operator== ( const DataElementSetItem rhs) const

Returns true if this set item is equal to the given rhs item.

int cee::ug::DataElementSetItem::partId ( ) const

Returns the part id of this set item.

See also
DataPart::partId()
void cee::ug::DataElementSetItem::setElementIndex ( size_t  elementIndex)

Sets the element index of the set item.

The index must correspond to the index of the element in the DataElements object identified by the geometry and part id.

void cee::ug::DataElementSetItem::setGeometryId ( int  geometryId)

Sets the geometry id of this set item.

This id must correspond to the DataGeometry::id() of the geometry of the element

See also
DataGeometry::id
void cee::ug::DataElementSetItem::setPartId ( int  partId)

Sets the part id of this set item.

This id must correspond to the DataPart::partId() of the part of the element

See also
DataPart::partId()