#include <ConsItem.hpp>

Inheritance diagram for ConsItem:

Public Member Functions
	ConsItem (const CovParamId &paramid, const EConsType &type=EConsType::fromKey("DEFAULT"), double value=0.)

	ConsItem (const ConsItem &m)

ConsItem &	operator= (const ConsItem &m)

virtual	~ConsItem ()

virtual String	toString (const AStringFormat *strfmt=nullptr) const override
	ICloneable interface. More...

const EConsElem &	getType () const

int	getIGrf () const

int	getICov () const

int	getIV1 () const

int	getIV2 () const

void	setValue (double value)

void	setIcase (const EConsType &type)

const EConsType &	getIcase () const

double	getValue () const

bool	matchIGrf (int igrf0) const

bool	matchICov (int icov0) const

bool	matchType (const EConsElem &type0) const

bool	matchIV1 (int iv10) const

bool	matchIV2 (int iv20) const

const CovParamId &	getParamId () const

Public Member Functions inherited from 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 (int level) const final

Public Member Functions inherited from ICloneable
	ICloneable ()

virtual	~ICloneable ()

virtual ICloneable *	clone () const =0

Static Public Member Functions
static ConsItem *	create (const CovParamId &paramid, const EConsType &type=EConsType::fromKey("DEFAULT"), double value=0.)

static ConsItem *	createFromParamId (int icov=0, const EConsElem &elem=EConsElem::fromKey("UNKNOWN"), const EConsType &type=EConsType::fromKey("DEFAULT"), double value=0., int igrf=0, int iv1=0, int iv2=0)

static ConsItem	define (const EConsElem &elem=EConsElem::fromKey("UNKNOWN"), int icov=0, int iv1=0, int iv2=0, const EConsType &type=EConsType::fromKey("DEFAULT"), double value=0.)

Detailed Description

This class is used:

to define the constraints for the Model Automatic Fitting (authAssign true)
to define the non-stationary parameters of a Model

Constructor & Destructor Documentation

ConsItem::ConsItem	(	const CovParamId &	paramid,
		const EConsType &	type = `EConsType::fromKey("DEFAULT")`,
		double	value = `0.`
	)

ConsItem::ConsItem ( const ConsItem & m )

ConsItem::~ConsItem ( )

virtual

Member Function Documentation

ConsItem * ConsItem::create	(	const CovParamId &	paramid,
		const EConsType &	type = `EConsType::fromKey("DEFAULT")`,
		double	value = `0.`
	)

static

ConsItem * ConsItem::createFromParamId	(	int	icov = `0`,
		const EConsElem &	elem = `EConsElem::fromKey("UNKNOWN")`,
		const EConsType &	type = `EConsType::fromKey("DEFAULT")`,
		double	value = `0.`,
		int	igrf = `0`,
		int	iv1 = `0`,
		int	iv2 = `0`
	)

static

ConsItem ConsItem::define	(	const EConsElem &	elem = `EConsElem::fromKey("UNKNOWN")`,
		int	icov = `0`,
		int	iv1 = `0`,
		int	iv2 = `0`,
		const EConsType &	type = `EConsType::fromKey("DEFAULT")`,
		double	value = `0.`
	)

static

This function creates a constraints on a parameter This constraint will be used subsequently during the variogram fitting

Parameters

elem	The type of item on which the constraints applies (EConsElem.hpp)
icov	The rank of the covariance
iv1	The rank of the first variable
iv2	The rank of the second variable
type	The type of constraints (EConsType.hpp)
value	The value assigned to the constraint

Remarks: Do not forget to delete object after usage

Returns

const EConsType& ConsItem::getIcase ( ) const

inline

int ConsItem::getICov ( ) const

inline

int ConsItem::getIGrf ( ) const

inline

int ConsItem::getIV1 ( ) const

inline

int ConsItem::getIV2 ( ) const

inline

const CovParamId& ConsItem::getParamId ( ) const

inline

const EConsElem& ConsItem::getType ( ) const

inline

double ConsItem::getValue ( ) const

inline

bool ConsItem::matchICov ( int icov0 ) const

inline

bool ConsItem::matchIGrf ( int igrf0 ) const

inline

bool ConsItem::matchIV1 ( int iv10 ) const

inline

bool ConsItem::matchIV2 ( int iv20 ) const

inline

bool ConsItem::matchType ( const EConsElem & type0 ) const

inline

ConsItem & ConsItem::operator= ( const ConsItem & m )

void ConsItem::setIcase ( const EConsType & type )

inline

void ConsItem::setValue ( double value )

inline

String ConsItem::toString ( const AStringFormat * strfmt = nullptr ) const

overridevirtual

ICloneable interface.

AStringable Interface

Reimplemented from AStringable.

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

include/Model/ConsItem.hpp
src/Model/ConsItem.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation