RINGMesh  Version 5.0.0
A programming library for geological model meshes
RINGMesh::gme_id< Entity_type_template > Struct Template Reference

Unique identification of a GeoModelEntity in a GeoModel It contains the EntityType and the index of the entity. It is widely used in the code to easily access/modify/set a GeoModelEntity. More...

#include <entity_type.h>

Public Member Functions

index_t index () const
 
Entity_type_template type () const
 
bool operator!= (const gme_id &rhs) const
 
bool operator== (const gme_id &rhs) const
 
bool operator< (const gme_id &rhs) const
 

Public Attributes

friend GeoModelMeshEntityAccess< 2 >
 
friend GeoModelGeologicalEntityAccess< 2 >
 
friend GeoModelMeshEntityAccess< 3 >
 
friend GeoModelGeologicalEntityAccess< 3 >
 

Protected Member Functions

 gme_id ()=default
 
 gme_id (Entity_type_template entity_type, index_t index)
 

Protected Attributes

Entity_type_template type_
 
index_t index_ { NO_ID }
 

Friends

std::ostream & operator<< (std::ostream &os, const gme_id &in)
 

Detailed Description

template<class Entity_type_template>
struct RINGMesh::gme_id< Entity_type_template >

Unique identification of a GeoModelEntity in a GeoModel It contains the EntityType and the index of the entity. It is widely used in the code to easily access/modify/set a GeoModelEntity.

Definition at line 189 of file entity_type.h.

Constructor & Destructor Documentation

◆ gme_id() [1/2]

template<class Entity_type_template>
RINGMesh::gme_id< Entity_type_template >::gme_id ( )
protecteddefault

◆ gme_id() [2/2]

template<class Entity_type_template>
RINGMesh::gme_id< Entity_type_template >::gme_id ( Entity_type_template  entity_type,
index_t  index 
)
inlineprotected

Definition at line 245 of file entity_type.h.

Member Function Documentation

◆ index()

template<class Entity_type_template>
index_t RINGMesh::gme_id< Entity_type_template >::index ( ) const
inline

Definition at line 197 of file entity_type.h.

◆ operator!=()

template<class Entity_type_template>
bool RINGMesh::gme_id< Entity_type_template >::operator!= ( const gme_id< Entity_type_template > &  rhs) const
inline

Definition at line 207 of file entity_type.h.

◆ operator<()

template<class Entity_type_template>
bool RINGMesh::gme_id< Entity_type_template >::operator< ( const gme_id< Entity_type_template > &  rhs) const
inline
Warning
Is this now enough for EntityType = std::string? Did any code relied on that sorting? Maybe mine ... [JP]

Definition at line 223 of file entity_type.h.

◆ operator==()

template<class Entity_type_template>
bool RINGMesh::gme_id< Entity_type_template >::operator== ( const gme_id< Entity_type_template > &  rhs) const
inline

Definition at line 212 of file entity_type.h.

◆ type()

template<class Entity_type_template>
Entity_type_template RINGMesh::gme_id< Entity_type_template >::type ( ) const
inline

Definition at line 202 of file entity_type.h.

Friends And Related Function Documentation

◆ operator<<

template<class Entity_type_template>
std::ostream& operator<< ( std::ostream &  os,
const gme_id< Entity_type_template > &  in 
)
friend

Definition at line 217 of file entity_type.h.

Member Data Documentation

◆ GeoModelGeologicalEntityAccess< 2 >

template<class Entity_type_template>
friend RINGMesh::gme_id< Entity_type_template >::GeoModelGeologicalEntityAccess< 2 >

Definition at line 192 of file entity_type.h.

◆ GeoModelGeologicalEntityAccess< 3 >

template<class Entity_type_template>
friend RINGMesh::gme_id< Entity_type_template >::GeoModelGeologicalEntityAccess< 3 >

Definition at line 194 of file entity_type.h.

◆ GeoModelMeshEntityAccess< 2 >

template<class Entity_type_template>
friend RINGMesh::gme_id< Entity_type_template >::GeoModelMeshEntityAccess< 2 >

Definition at line 191 of file entity_type.h.

◆ GeoModelMeshEntityAccess< 3 >

template<class Entity_type_template>
friend RINGMesh::gme_id< Entity_type_template >::GeoModelMeshEntityAccess< 3 >

Definition at line 193 of file entity_type.h.

◆ index_

template<class Entity_type_template>
index_t RINGMesh::gme_id< Entity_type_template >::index_ { NO_ID }
protected

Index of the GeoModelEntity in the GeoModel

Definition at line 255 of file entity_type.h.

◆ type_

template<class Entity_type_template>
Entity_type_template RINGMesh::gme_id< Entity_type_template >::type_
protected

Definition at line 251 of file entity_type.h.


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