Variable.hxx File Reference

#include <string>
#include <vector>
#include <string_view>
#include "MGIS/Config.hxx"
#include "MGIS/Behaviour/Hypothesis.hxx"

Classes
struct	mgis::behaviour::Variable
	structure describing a variable More...

Namespaces
namespace	mgis
	the namespace mgis encloses all the MGIS project.

Functions
MGIS_EXPORT bool	mgis::behaviour::contains (const std::vector< Variable > &, const std::string_view)
MGIS_EXPORT const Variable &	mgis::behaviour::getVariable (const std::vector< Variable > &, const std::string_view)
MGIS_EXPORT Variable::Type	mgis::behaviour::getVariableType (const int)
MGIS_EXPORT std::string	mgis::behaviour::getVariableTypeSymbolicRepresentation (const int)
MGIS_EXPORT size_type	mgis::behaviour::getVariableSize (const Variable &, const Hypothesis)
MGIS_EXPORT size_type	mgis::behaviour::getArraySize (const std::vector< Variable > &, const Hypothesis)
MGIS_EXPORT size_type	mgis::behaviour::getVariableOffset (const std::vector< Variable > &, const std::string_view, const Hypothesis)
MGIS_EXPORT std::string	mgis::behaviour::getVariableTypeAsString (const Variable &)

Detailed Description

Author

Thomas Helfer

Date

19/06/2018

Copyright

(C) Copyright Thomas Helfer 2018. Use, modification and distribution are subject to one of the following licences:

• GNU Lesser General Public License (LGPL), Version 3.0. (See accompanying file LGPL-3.0.txt)
• CECILL-C, Version 1.0 (See accompanying files CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt).

Function Documentation

contains()

MGIS_EXPORT bool mgis::behaviour::contains	(	const std::vector< Variable > &	,
		const std::string_view
	)

Returns

a boolean stating that a variable with the given name is in the container.

Parameters

[in]	vs	variables
[in]	n	name

getArraySize()

MGIS_EXPORT size_type mgis::behaviour::getArraySize	(	const std::vector< Variable > &	,
		const Hypothesis
	)

Returns

the size of an array that may contain the values described by the given array of variables

Parameters

[in]	vs	variables
[in]	h	modelling hypothesis

getVariable()

MGIS_EXPORT const Variable & mgis::behaviour::getVariable	(	const std::vector< Variable > &	,
		const std::string_view
	)

Returns

the variable with the given name

Parameters

[in]	vs	variables
[in]	n	name

getVariableOffset()

MGIS_EXPORT size_type mgis::behaviour::getVariableOffset	(	const std::vector< Variable > &	,
		const std::string_view	,
		const Hypothesis
	)

Returns

the offset of the given variable for the given hypothesis

Parameters

[in]	vs	variables
[in]	n	variable name
[in]	h	modelling hypothesis

getVariableSize()

MGIS_EXPORT size_type mgis::behaviour::getVariableSize	(	const Variable &	,
		const Hypothesis
	)

Returns

the size of a variable

Parameters

[in]	v	variable
[in]	h	modelling hypothesis

getVariableType()

MGIS_EXPORT Variable::Type mgis::behaviour::getVariableType

(

const int

)

Returns

the type of a variable from an identifier

Parameters

[in]

id

type identifier

getVariableTypeAsString()

MGIS_EXPORT std::string mgis::behaviour::getVariableTypeAsString

(

const Variable &

)

Returns

the type of the given variable as a string

Parameters

[in]

v

variable

getVariableTypeSymbolicRepresentation()

MGIS_EXPORT std::string mgis::behaviour::getVariableTypeSymbolicRepresentation

(

const int

)

Returns

a symbolic representation from a type identifier

Parameters

[in]

id

type identifier