RINGMesh  Version 5.0.0
A programming library for geological model meshes
RINGMesh::RockFeature Class Reference

Manages the RockFeature, which contains a RockType and more informations. More...

#include <stratigraphic_column.h>

Public Member Functions

 RockFeature (std::string name, ROCKTYPE type)
 Complete constructor of a RockFeature. More...
 
 RockFeature (std::string name)
 Simple constructor of RockFeature. More...
 
const std::string & get_name () const
 
void set_name (const std::string &name)
 
const ROCKTYPEget_rock_type () const
 
void set_rock_type (ROCKTYPE type)
 

Private Attributes

std::string name_ {}
 
ROCKTYPE type_ { ROCKTYPE::NONE }
 

Detailed Description

Manages the RockFeature, which contains a RockType and more informations.

Definition at line 73 of file stratigraphic_column.h.

Constructor & Destructor Documentation

◆ RockFeature() [1/2]

RINGMesh::RockFeature::RockFeature ( std::string  name,
ROCKTYPE  type 
)
inline

Complete constructor of a RockFeature.

Parameters
[in]nameName of the feature
[in]typeRocktype

Definition at line 81 of file stratigraphic_column.h.

◆ RockFeature() [2/2]

RINGMesh::RockFeature::RockFeature ( std::string  name)
inlineexplicit

Simple constructor of RockFeature.

Parameters
[in]nameName of the feature

Definition at line 89 of file stratigraphic_column.h.

Member Function Documentation

◆ get_name()

const std::string& RINGMesh::RockFeature::get_name ( ) const
inline
Returns
name of the feature

Definition at line 97 of file stratigraphic_column.h.

◆ get_rock_type()

const ROCKTYPE& RINGMesh::RockFeature::get_rock_type ( ) const
inline

Definition at line 106 of file stratigraphic_column.h.

◆ set_name()

void RINGMesh::RockFeature::set_name ( const std::string &  name)
inline

Definition at line 101 of file stratigraphic_column.h.

◆ set_rock_type()

void RINGMesh::RockFeature::set_rock_type ( ROCKTYPE  type)
inline

Definition at line 111 of file stratigraphic_column.h.

Member Data Documentation

◆ name_

std::string RINGMesh::RockFeature::name_ {}
private

Definition at line 117 of file stratigraphic_column.h.

◆ type_

ROCKTYPE RINGMesh::RockFeature::type_ { ROCKTYPE::NONE }
private

Definition at line 118 of file stratigraphic_column.h.


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