cee::ug::DataNodeSetItem Class Reference

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

Public Member Functions

 DataNodeSetItem ()
 Constructs an empty item. More...
 
 DataNodeSetItem (int geometryId, int partId, size_t nodeIndex)
 Constructs a set item with the given data. More...
 
 DataNodeSetItem (const DataNodeSetItem &other)
 Constructs an item as a copy of other. More...
 
const DataNodeSetItemoperator= (const DataNodeSetItem &other)
 Assigns other to this item and returns a reference to this item. More...
 
bool operator== (const DataNodeSetItem &rhs) const
 Returns true if this set item is equal to the given rhs item. More...
 
bool operator!= (const DataNodeSetItem &rhs) const
 Returns true if this set item is not equal to the given rhs item. More...
 
bool operator< (const DataNodeSetItem &other) const
 Returns true if this item is less than the passed item other. More...
 
bool operator> (const DataNodeSetItem &other) const
 Returns true if this item is larger than the passed item other. 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 nodeIndex () const
 Returns the node index or the set item. More...
 
void setNodeIndex (size_t nodeIndex)
 Sets the node index of the set item. More...
 

Detailed Description

This class identifies a node within an UnstructGrid model and is used as an item in a DataNodeSet.

A node is uniquely identified within a UnstructGrid DataSource by three numbers:

See also
DataNodeSet

Constructor & Destructor Documentation

cee::ug::DataNodeSetItem::DataNodeSetItem ( )

Constructs an empty item.

cee::ug::DataNodeSetItem::DataNodeSetItem ( int  geometryId,
int  partId,
size_t  nodeIndex 
)

Constructs a set item with the given data.

cee::ug::DataNodeSetItem::DataNodeSetItem ( const DataNodeSetItem other)

Constructs an item as a copy of other.

Member Function Documentation

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

Returns the geometry id of this set item.

See also
DataGeometry::id
size_t cee::ug::DataNodeSetItem::nodeIndex ( ) const

Returns the node index or the set item.

bool cee::ug::DataNodeSetItem::operator!= ( const DataNodeSetItem rhs) const

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

bool cee::ug::DataNodeSetItem::operator< ( const DataNodeSetItem other) const

Returns true if this item is less than the passed item other.

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

Assigns other to this item and returns a reference to this item.

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

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

bool cee::ug::DataNodeSetItem::operator> ( const DataNodeSetItem other) const

Returns true if this item is larger than the passed item other.

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

Returns the part id of this set item.

See also
DataPart::partId()
void cee::ug::DataNodeSetItem::setGeometryId ( int  geometryId)

Sets the geometry id of this set item.

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

See also
DataGeometry::id
void cee::ug::DataNodeSetItem::setNodeIndex ( size_t  nodeIndex)

Sets the node index of the set item.

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

void cee::ug::DataNodeSetItem::setPartId ( int  partId)

Sets the part id of this set item.

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

See also
DataPart::partId()