gstlrn::SimuSubstitutionParam Class Reference

#include <SimuSubstitutionParam.hpp>

Inheritance diagram for gstlrn::SimuSubstitutionParam:

Public Member Functions
	SimuSubstitutionParam (Id nfacies=2, double intensity=0.1, bool flag_direct=true, bool flag_coding=true, bool flag_orient=false)
	SimuSubstitutionParam (const SimuSubstitutionParam &r)
SimuSubstitutionParam &	operator= (const SimuSubstitutionParam &r)
virtual	~SimuSubstitutionParam ()
String	toString (const AStringFormat *strfmt=nullptr) const override
	Interface to AStringable.
const &	getColang () const
void	setColang (const 1 &colang)
Id	getColfac () const
void	setColfac (Id colfac)
double	getFactor () const
void	setFactor (double factor)
bool	isFlagAuto () const
void	setFlagAuto (bool flagAuto)
bool	isFlagCoding () const
void	setFlagCoding (bool flagCoding)
bool	isFlagDirect () const
void	setFlagDirect (bool flagDirect)
bool	isFlagOrient () const
void	setFlagOrient (bool flagOrient)
double	getIntensity () const
void	setIntensity (double intensity)
Id	getNfacies () const
void	setNfacies (Id nfacies)
Id	getNstates () const
void	setNstates (Id nstates)
	getTrans () const
void	setTrans (const 1 &trans)
const &	getVector () const
void	setVector (const 1 &vector)
Id	getColang (Id idim) const
double	getVector (Id idim) const
bool	isValid (bool verbose=false)
bool	isAngleLocal () const
bool	isLocal () const
Public Member Functions inherited from gstlrn::AStringable
	AStringable ()
	AStringable (const AStringable &r)
AStringable &	operator= (const AStringable &r)
virtual	~AStringable ()
virtual void	display (const AStringFormat *strfmt=nullptr) const final
virtual void	display (Id level) const final

Static Public Member Functions
static void	isValidOrientation (1 &vector, bool verbose=false)
static void	isValidFactor (double *factor, bool verbose=false)

Constructor & Destructor Documentation

SimuSubstitutionParam() [1/2]

gstlrn::SimuSubstitutionParam::SimuSubstitutionParam	(	Id	nfacies = 2,
		double	intensity = 0.1,
		bool	flag_direct = true,
		bool	flag_coding = true,
		bool	flag_orient = false
	)

SimuSubstitutionParam() [2/2]

gstlrn::SimuSubstitutionParam::SimuSubstitutionParam

(

const SimuSubstitutionParam &

r

)

~SimuSubstitutionParam()

gstlrn::SimuSubstitutionParam::~SimuSubstitutionParam ( )

virtual

Member Function Documentation

getColang() [1/2]

const & gstlrn::SimuSubstitutionParam::getColang ( ) const

inline

getColang() [2/2]

Id gstlrn::SimuSubstitutionParam::getColang

(

Id

idim

)

const

getColfac()

Id gstlrn::SimuSubstitutionParam::getColfac ( ) const

inline

getFactor()

double gstlrn::SimuSubstitutionParam::getFactor ( ) const

inline

getIntensity()

double gstlrn::SimuSubstitutionParam::getIntensity ( ) const

inline

getNfacies()

Id gstlrn::SimuSubstitutionParam::getNfacies ( ) const

inline

getNstates()

Id gstlrn::SimuSubstitutionParam::getNstates ( ) const

inline

getTrans()

gstlrn::SimuSubstitutionParam::getTrans ( ) const

inline

getVector() [1/2]

const & gstlrn::SimuSubstitutionParam::getVector ( ) const

inline

getVector() [2/2]

double gstlrn::SimuSubstitutionParam::getVector ( Id  idim ) const

inline

isAngleLocal()

bool gstlrn::SimuSubstitutionParam::isAngleLocal

(

)

const

isFlagAuto()

bool gstlrn::SimuSubstitutionParam::isFlagAuto ( ) const

inline

isFlagCoding()

bool gstlrn::SimuSubstitutionParam::isFlagCoding ( ) const

inline

isFlagDirect()

bool gstlrn::SimuSubstitutionParam::isFlagDirect ( ) const

inline

isFlagOrient()

bool gstlrn::SimuSubstitutionParam::isFlagOrient ( ) const

inline

isLocal()

bool gstlrn::SimuSubstitutionParam::isLocal

(

)

const

isValid()

bool gstlrn::SimuSubstitutionParam::isValid

(

bool

verbose = false

)

isValidFactor()

void gstlrn::SimuSubstitutionParam::isValidFactor ( double *  factor, bool  verbose = false  )

static

isValidOrientation()

void gstlrn::SimuSubstitutionParam::isValidOrientation ( 1 &  vector, bool  verbose = false  )

static

operator=()

SimuSubstitutionParam & gstlrn::SimuSubstitutionParam::operator=

(

const SimuSubstitutionParam &

r

)

setColang()

void gstlrn::SimuSubstitutionParam::setColang ( const 1 &  colang )

inline

setColfac()

void gstlrn::SimuSubstitutionParam::setColfac ( Id  colfac )

inline

setFactor()

void gstlrn::SimuSubstitutionParam::setFactor ( double  factor )

inline

setFlagAuto()

void gstlrn::SimuSubstitutionParam::setFlagAuto ( bool  flagAuto )

inline

setFlagCoding()

void gstlrn::SimuSubstitutionParam::setFlagCoding ( bool  flagCoding )

inline

setFlagDirect()

void gstlrn::SimuSubstitutionParam::setFlagDirect ( bool  flagDirect )

inline

setFlagOrient()

void gstlrn::SimuSubstitutionParam::setFlagOrient ( bool  flagOrient )

inline

setIntensity()

void gstlrn::SimuSubstitutionParam::setIntensity ( double  intensity )

inline

setNfacies()

void gstlrn::SimuSubstitutionParam::setNfacies ( Id  nfacies )

inline

setNstates()

void gstlrn::SimuSubstitutionParam::setNstates ( Id  nstates )

inline

setTrans()

void gstlrn::SimuSubstitutionParam::setTrans ( const 1 &  trans )

inline

setVector()

void gstlrn::SimuSubstitutionParam::setVector ( const 1 &  vector )

inline

toString()

String gstlrn::SimuSubstitutionParam::toString ( const AStringFormat *  strfmt = nullptr ) const

overridevirtual

Interface to AStringable.

Reimplemented from gstlrn::AStringable.

---

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

• include/Simulation/SimuSubstitutionParam.hpp
• src/Simulation/SimuSubstitutionParam.cpp