#include <AltaricaModel.hh>

Public Types
typedef reference_wrapper< AltaricaModel >	Reference

typedef reference_wrapper< AltaricaModel const >	ConstReference

typedef AltaricaModel *	Pointer

typedef const AltaricaModel *	ConstPointer

typedef vector< NodeDecl::Reference >	NodeDecls

typedef NodeDecls::const_iterator	NodeDeclIterator

typedef unordered_map< Identifier, Domain::ConstReference >	DomainDictionary

typedef unordered_map< Identifier, Value::ConstReference >	ConstantDictionary

typedef unordered_map< Identifier, NodeDecl::Reference >	NodeDeclDictionary

Public Member Functions
Constants
const ConstantDictionary &	constants () const

void	addConstant (const Identifier &name, const Value &value)

const Value &	getConstant (const Identifier &name) const

Constructors/Destructor
	AltaricaModel (const Identifier &name)

	~AltaricaModel ()

BasicAccessors
Basic methods of AltaricaModel
const Identifier &	name () const

bool	operator== (const AltaricaModel &model) const

bool	operator!= (const AltaricaModel &model) const

TypeAccessors
Methods to access the Type of the elements of the current model
const Type &	nullType () const

const Type &	getBoolean () const

const Type &	getIdentifier () const

const Type &	getInteger () const

const Type &	getStructureType (const Type::StructureFields &fields) const

const Type &	getArrayType (const Type &type, unsigned size) const

ValueAccessors
Methods to access the Value involved in the elements of the current model
const Value &	nullValue () const

const Value &	getValue (const Identifier &value) const

const Value &	getValue (bool value) const

const Value &	getValue (int value) const

const Value &	getValue (const Value::ArrayFields &array) const

const Value &	getValue (const Value::StructureFields &structure) const

DomainAccessors
Methods to access the Domains involved in the elements of the current model
const Domain &	getBooleans () const

const Domain &	getIntegers () const

const Domain &	newDomain (const Identifier &name, const Domain &associatedDomain, NodeDecl &node)

const Domain &	newDomain (const Identifier &name, const Value &min, const Value &max, NodeDecl &node)

const Domain &	newDomain (const Identifier &name, const ValueEnumeration &enumeration, NodeDecl &node)

const Domain &	newDomain (const Identifier &name, const map< Identifier, Domain::ConstReference > &structure, NodeDecl &node)

const Domain &	newDomain (const Identifier &name, const Domain &domain, unsigned size, NodeDecl &node)

const Domain &	getDomain (const Identifier &name, NodeDecl &node)

const Domain &	getDomain (const NodeDecl &node)

const Domain &	nullDomain () const

const vector< Domain::ConstReference > &	domains () const

VariableDeclAccessors
VariableDecl &	getNodeVariableDecl (const Identifier &id, NodeDecl &node, const set< Identifier > &attributes, VariableDecl &scope)

VariableDecl &	getVariableDecl (const Diades::Utils::Identifier &label, NodeDecl::VarType type, const Domain &domain, const set< Identifier > &attributes, VariableDecl &scope)

const VariableDecl &	nullVariableDecl () const

VariableDecl &	nullVariableDecl ()

const VariableDeclFactory &	variableDeclFactory () const

NodeAccessors
Methods to access the Nodes involved in the elements of the current model
void	noMainNodeDecl ()

void	setMainNodeDecl (const Identifier &name)

bool	containsNodeDecl (const Identifier &nodeName) const

NodeDecl &	getNodeDecl (const Identifier &nodeName)

NodeDecl &	nullNodeDecl ()

const NodeDecl &	nullNodeDecl () const

unsigned	numberOfNodeDecls () const

NodeDeclIterator	nodeDeclBegin () const

NodeDeclIterator	nodeDeclEnd () const

model construction methods
These methods are use to "fill" the declared nodes
EventDecl &	getEventDecl (const Identifier &id, NodeDecl &owner)

const EventDecl &	getEventDecl (const Identifier &id, const NodeDecl &owner) const

const EventDecl &	nullEventDecl () const

EventDecl &	nullEventDecl ()

model instance methods
These methods are use to instanciate the declared model
const VariableDecl &	mainVariableDecl () const

VariableDecl &	mainVariableDecl ()

const NodeDecl &	mainNodeDecl () const

NodeDecl &	mainNodeDecl ()

parameter methods
These methods are use to instanciate the parameters
const ParameterDecl &	getParameterDecl (const Identifier &name, const Domain &domain, NodeDecl &node)

const ParameterDecl &	nullParameterDecl () const

Private Member Functions
unsigned	typeIndex (Domain::DomainType type) const

Exception
Exception mechanism
typedef Utils::Exception< AltaricaModel >	Exception

static string	typeName ()

ExpressionAccessors
typedef ExpressionFactory::ExprVector	ExprVector

const Expression &	getVarExpression (const NodeDecl &node, const VariableDecl &var)

const Expression &	getIdentifierExpression (const NodeDecl &node, const Identifier &id)

const Expression &	getBooleanExpression (Expression::Category category)

const Expression &	getIntegerExpression (int value)

const Expression &	getIteExpression (const NodeDecl &node, const Expression &ifE, const Expression &thenE, const Expression &elseE)

const Expression &	getCaseExpression (const NodeDecl &node, const ExprVector &choices, const ExprVector &expressions)

const Expression &	getBinaryExpression (const NodeDecl &node, Expression::Category category, const Expression &left, const Expression &right)

const Expression &	getUnaryExpression (const NodeDecl &node, Expression::Category category, const Expression &expr)

const Expression &	getListExpression (const NodeDecl &node, Expression::Category category, const ExprVector &expressions)

const Expression &	getStructExpression (const NodeDecl &node, const vector< Identifier > &identifiers, const ExprVector &expressions)

Detailed Description

Class that implements a internal representation of a model written in alatarca language. This is the fundamental class to use altarica models with Dialtarica.

Definition at line 28 of file AltaricaModel.hh.

Member Typedef Documentation

◆ ConstantDictionary

typedef unordered_map<Identifier,Value::ConstReference> Diades::Altarica::AltaricaModel::ConstantDictionary

ConstantDictionary dictionary of the global domains

Definition at line 103 of file AltaricaModel.hh.

◆ ConstPointer

typedef const AltaricaModel* Diades::Altarica::AltaricaModel::ConstPointer

Definition at line 35 of file AltaricaModel.hh.

◆ ConstReference

typedef reference_wrapper<AltaricaModel const> Diades::Altarica::AltaricaModel::ConstReference

Definition at line 33 of file AltaricaModel.hh.

◆ DomainDictionary

typedef unordered_map<Identifier,Domain::ConstReference> Diades::Altarica::AltaricaModel::DomainDictionary

DomainDictionary dictionary of the global domains

Definition at line 99 of file AltaricaModel.hh.

◆ Exception

typedef Utils::Exception<AltaricaModel> Diades::Altarica::AltaricaModel::Exception

Definition at line 162 of file AltaricaModel.hh.

◆ ExprVector

typedef ExpressionFactory::ExprVector Diades::Altarica::AltaricaModel::ExprVector

ExprVector vector of constant Expression references

Definition at line 817 of file AltaricaModel.hh.

◆ NodeDeclDictionary

typedef unordered_map<Identifier,NodeDecl::Reference> Diades::Altarica::AltaricaModel::NodeDeclDictionary

NodeDeclDictionary dictionary of the node declarations

Definition at line 107 of file AltaricaModel.hh.

◆ NodeDeclIterator

typedef NodeDecls::const_iterator Diades::Altarica::AltaricaModel::NodeDeclIterator

NodeDeclIterator iterator of NodeDecls

Definition at line 95 of file AltaricaModel.hh.

◆ NodeDecls

typedef vector<NodeDecl::Reference> Diades::Altarica::AltaricaModel::NodeDecls

NodeDecls vector of node declarations

Definition at line 91 of file AltaricaModel.hh.

◆ Pointer

typedef AltaricaModel* Diades::Altarica::AltaricaModel::Pointer

Definition at line 34 of file AltaricaModel.hh.

◆ Reference

typedef reference_wrapper<AltaricaModel> Diades::Altarica::AltaricaModel::Reference

Definition at line 32 of file AltaricaModel.hh.

Constructor & Destructor Documentation

◆ AltaricaModel()

Diades::Altarica::AltaricaModel::AltaricaModel ( const Identifier & name )

Parametrised constructor creation of a new altarica model.

Parameters

name	the name of the new model

Referenced by getConstant().

◆ ~AltaricaModel()

Diades::Altarica::AltaricaModel::~AltaricaModel ( )

Destructor.

Referenced by getConstant().

Member Function Documentation

◆ addConstant()

void Diades::Altarica::AltaricaModel::addConstant	(	const Identifier &	name,
		const Value &	value
	)

inline

Definition at line 177 of file AltaricaModel.hh.

References always_require, and getConstant().

◆ constants()

const ConstantDictionary& Diades::Altarica::AltaricaModel::constants ( ) const

inline

Definition at line 172 of file AltaricaModel.hh.

References _constantDictionary.

◆ containsNodeDecl()

bool Diades::Altarica::AltaricaModel::containsNodeDecl ( const Identifier & nodeName ) const

Parameters

nodeName the identifier of a NodeDecl

Returns: true if such a node is present in the model

Todo:: test

Referenced by setMainNodeDecl().

◆ domains()

const vector<Domain::ConstReference>& Diades::Altarica::AltaricaModel::domains ( ) const

inline

Returns: the global user-defined domains

Definition at line 598 of file AltaricaModel.hh.

References _globalDomains.

◆ getArrayType()

const Type& Diades::Altarica::AltaricaModel::getArrayType	(	const Type &	type,
		unsigned	size
	)		const

inline

Parameters

type	Type of an element
size	Size of the array

Returns: the Type array<Type>[size]

Definition at line 351 of file AltaricaModel.hh.

References Diades::Altarica::TypeFactory::getArrayType(), and nullType().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getBinaryExpression()

const Expression& Diades::Altarica::AltaricaModel::getBinaryExpression	(	const NodeDecl &	node,
		Expression::Category	category,
		const Expression &	left,
		const Expression &	right
	)

inline

Parameters

node	the owner of the Expression
category	Category of the expression (Binary categories like Or And Add etc)
left	the left member
right	the right member

Returns: the corresponding binary Expression

Definition at line 912 of file AltaricaModel.hh.

References Diades::Altarica::ExpressionFactory::getBinaryExpression().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getBoolean()

const Type& Diades::Altarica::AltaricaModel::getBoolean ( ) const

inline

Boolean type

Returns: the boolean type of the model

Definition at line 295 of file AltaricaModel.hh.

References Diades::Altarica::TypeFactory::getBoolean().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getBooleanExpression()

const Expression& Diades::Altarica::AltaricaModel::getBooleanExpression ( Expression::Category category )

inline

Parameters

category the category (either True or False)

Returns: the boolean Expression associated with this category

Definition at line 853 of file AltaricaModel.hh.

References Diades::Altarica::ExpressionFactory::getBooleanExpression().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getBooleans()

const Domain& Diades::Altarica::AltaricaModel::getBooleans ( ) const

inline

Returns: the boolean domain

Definition at line 485 of file AltaricaModel.hh.

References Diades::Altarica::DomainFactory::getBooleans().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getCaseExpression()

const Expression& Diades::Altarica::AltaricaModel::getCaseExpression	(	const NodeDecl &	node,
		const ExprVector &	choices,
		const ExprVector &	expressions
	)

inline

Parameters

node	the owner of the Expression*
choices	the set of cases
expressions	the set of expressions (cases[i] associated with expressions[i]) plus the default case

Returns: the corresponding Case Expression

Definition at line 895 of file AltaricaModel.hh.

References Diades::Altarica::ExpressionFactory::getCaseExpression().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getConstant()

const Value& Diades::Altarica::AltaricaModel::getConstant ( const Identifier & name ) const

inline

Definition at line 184 of file AltaricaModel.hh.

References AltaricaModel(), name(), nullValue(), and ~AltaricaModel().

Referenced by addConstant().

◆ getDomain() [1/2]

const Domain& Diades::Altarica::AltaricaModel::getDomain	(	const Identifier &	name,
		NodeDecl &	node
	)

Get the domain of the model with this name

Parameters

name	the name of the resulting Domain
nodeDecl	the nodeDecl where is the domain (NodelDecl() is it is the global one)

Returns: the Domain with this name or an invalid one if it does not exist.

Todo:: test

Referenced by getIntegers().

◆ getDomain() [2/2]

const Domain& Diades::Altarica::AltaricaModel::getDomain ( const NodeDecl & node )

Get the domain associated to the Node

Parameters

nodeDecl the nodeDecl

Returns: the Domain of the NodeDecl. A NodeDecl can be seen as a structured VariableDecl whose the Domain is the one returned by this method

Todo:: test

◆ getEventDecl() [1/2]

EventDecl& Diades::Altarica::AltaricaModel::getEventDecl	(	const Identifier &	id,
		NodeDecl &	owner
	)

inline

Get an event declaration

Parameters

label	the label of the event declaration
nodeDecl	the owner of the event declaration

Returns: the event 'label' declared in the node 'owner'

Todo:: test

Definition at line 970 of file AltaricaModel.hh.

References always_require, Diades::Altarica::EventDeclFactory::getEventDecl(), and Diades::Altarica::NodeDecl::owner().

◆ getEventDecl() [2/2]

const EventDecl& Diades::Altarica::AltaricaModel::getEventDecl	(	const Identifier &	id,
		const NodeDecl &	owner
	)		const

inline

Get an event declaration

Parameters

label	the label of the event declaration
nodeDecl	the owner of the event declaration

Returns: the event 'label' declared in the node 'owner'

Todo:: test

Definition at line 982 of file AltaricaModel.hh.

References always_require, Diades::Altarica::EventDeclFactory::getEventDecl(), and Diades::Altarica::NodeDecl::owner().

◆ getIdentifier()

const Type& Diades::Altarica::AltaricaModel::getIdentifier ( ) const

inline

Identifier type

Returns: the identifier type of the model

Definition at line 305 of file AltaricaModel.hh.

References Diades::Altarica::TypeFactory::getIdentifier().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getIdentifierExpression()

const Expression& Diades::Altarica::AltaricaModel::getIdentifierExpression	(	const NodeDecl &	node,
		const Identifier &	id
	)

inline

Parameters

node	the owner of the identifer
id	an Identifier

Returns: the Expression associated with this Identifier

Definition at line 841 of file AltaricaModel.hh.

References Diades::Altarica::ExpressionFactory::getIdentifierExpression().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getInteger()

const Type& Diades::Altarica::AltaricaModel::getInteger ( ) const

inline

Integer type

Returns: the integer type of the model

Definition at line 316 of file AltaricaModel.hh.

References Diades::Altarica::TypeFactory::getInteger().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getIntegerExpression()

const Expression& Diades::Altarica::AltaricaModel::getIntegerExpression ( int value )

inline

Parameters

value a integer

Returns: the boolean Expression associated with this integer

Definition at line 866 of file AltaricaModel.hh.

References Diades::Altarica::ExpressionFactory::getIntegerExpression().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getIntegers()

const Domain& Diades::Altarica::AltaricaModel::getIntegers ( ) const

inline

Returns: the integer domain

Definition at line 494 of file AltaricaModel.hh.

References getDomain(), Diades::Altarica::DomainFactory::getIntegers(), and newDomain().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getIteExpression()

const Expression& Diades::Altarica::AltaricaModel::getIteExpression	(	const NodeDecl &	node,
		const Expression &	ifE,
		const Expression &	thenE,
		const Expression &	elseE
	)

inline

Parameters

node	the owner of the Expression
ifE	a boolean Expression
thenE	an Expression
elseE	an Expression

Returns: the If/Then/Else Expression

Definition at line 881 of file AltaricaModel.hh.

References Diades::Altarica::ExpressionFactory::getIteExpression().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getListExpression()

const Expression& Diades::Altarica::AltaricaModel::getListExpression	(	const NodeDecl &	node,
		Expression::Category	category,
		const ExprVector &	expressions
	)

inline

Parameters

node	the owner of the Expression
category	Category of the expression (categories made of expression list like min max array...)
expressions	the list of expressions)

Returns: the corresponding Expression

Definition at line 938 of file AltaricaModel.hh.

References Diades::Altarica::ExpressionFactory::getListExpression().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getNodeDecl()

NodeDecl& Diades::Altarica::AltaricaModel::getNodeDecl ( const Identifier & nodeName )

Parameters

nodeName the identifier of a NodeDecl

Returns: the NodeDecl with the name 'nodeName'

Todo:: test

Referenced by analyseComponent(), and setMainNodeDecl().

◆ getNodeVariableDecl()

VariableDecl& Diades::Altarica::AltaricaModel::getNodeVariableDecl	(	const Identifier &	id,
		NodeDecl &	node,
		const set< Identifier > &	attributes,
		VariableDecl &	scope
	)

inline

Get the VariableDecl associated to a NodeDecl

Parameters

node	the given node
attributes	the attributes of the Variable
scope	the scope of the Variable. If the scope is VariableDecl(), it is the global scope

Returns: the VariableDecl for this NodeDecl

Definition at line 624 of file AltaricaModel.hh.

References Diades::Altarica::VariableDeclFactory::getNodeVariableDecl(), and nullVariableDecl().

◆ getParameterDecl()

const ParameterDecl& Diades::Altarica::AltaricaModel::getParameterDecl	(	const Identifier &	name,
		const Domain &	domain,
		NodeDecl &	node
	)

inline

Parameter declaration

Parameters

name	the identifier of the Parameter
domain	the domain of the Parameter
node	the NodeDec that owns the Parameter

Returns: the ParameterDecl

Definition at line 1086 of file AltaricaModel.hh.

References always_require, Diades::Altarica::ParameterDeclFactory::getParameterDecl(), Diades::Altarica::Domain::isNull(), and Diades::Utils::Identifier::str().

◆ getStructExpression()

const Expression& Diades::Altarica::AltaricaModel::getStructExpression	(	const NodeDecl &	node,
		const vector< Identifier > &	identifiers,
		const ExprVector &	expressions
	)

inline

Parameters

node	the owner of the Expression
identifiers	a set of identifiers (the field names of the structure)
expressions	a set of expressions (associated with each field name)

Returns: the corresponding Expressions

Definition at line 952 of file AltaricaModel.hh.

References Diades::Altarica::ExpressionFactory::getStructExpression().

◆ getStructureType()

const Type& Diades::Altarica::AltaricaModel::getStructureType ( const Type::StructureFields & fields ) const

inline

Get the structure type defined by fields

Parameters

fields a set of Type

Returns: the Type struct{ fields[0], fields[1],...}

Definition at line 328 of file AltaricaModel.hh.

References Diades::Altarica::TypeFactory::getStructureType(), and nullType().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getUnaryExpression()

const Expression& Diades::Altarica::AltaricaModel::getUnaryExpression	(	const NodeDecl &	node,
		Expression::Category	category,
		const Expression &	expr
	)

inline

Parameters

node	the owner of the Expression
category	Category of the expression (Unary categories like Not Neg Paren etc)
expr	the unique member

Returns: the corresponding unary Expression

Definition at line 925 of file AltaricaModel.hh.

References Diades::Altarica::ExpressionFactory::getUnaryExpression().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getValue() [1/5]

const Value& Diades::Altarica::AltaricaModel::getValue ( const Identifier & value ) const

inline

Parameters

value an Identifier

Returns: the Value of the model associated with 'value'

Precondition: !value.empty()

Definition at line 392 of file AltaricaModel.hh.

References Diades::Altarica::ValueFactory::getValue(), and nullValue().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getValue() [2/5]

const Value& Diades::Altarica::AltaricaModel::getValue ( bool value ) const

inline

Parameters

value an boolean

Returns: the Value of the model associated with 'value'

Definition at line 412 of file AltaricaModel.hh.

References Diades::Altarica::ValueFactory::getValue().

◆ getValue() [3/5]

const Value& Diades::Altarica::AltaricaModel::getValue ( int value ) const

inline

Parameters

value an integer

Returns: the Value of the model associated with 'value'

Definition at line 424 of file AltaricaModel.hh.

References Diades::Altarica::ValueFactory::getValue().

◆ getValue() [4/5]

const Value& Diades::Altarica::AltaricaModel::getValue ( const Value::ArrayFields & array ) const

inline

Parameters

array an array of Value

Returns: the Value of Type array<array[0].type()>[array.size]

Precondition: the Values in array must have the same Type.

Definition at line 437 of file AltaricaModel.hh.

References Diades::Altarica::ValueFactory::getValue(), and nullValue().

◆ getValue() [5/5]

const Value& Diades::Altarica::AltaricaModel::getValue ( const Value::StructureFields & structure ) const

inline

Parameters

structure an set of Values indedex with field names

Returns: the Value of Type structure{ fields[0],.... }

Precondition: the structure must not ne empty.

Definition at line 459 of file AltaricaModel.hh.

References Diades::Altarica::ValueFactory::getValue(), and nullValue().

◆ getVarExpression()

const Expression& Diades::Altarica::AltaricaModel::getVarExpression	(	const NodeDecl &	node,
		const VariableDecl &	var
	)

inline

Parameters

node	the owner of the VariableDecl
var	a VariableDecl

Returns: the Expression associated with this variable declaration

Definition at line 826 of file AltaricaModel.hh.

References Diades::Altarica::ExpressionFactory::getVarExpression().

Referenced by BOOST_AUTO_TEST_CASE().

◆ getVariableDecl()

VariableDecl& Diades::Altarica::AltaricaModel::getVariableDecl	(	const Diades::Utils::Identifier &	label,
		NodeDecl::VarType	type,
		const Domain &	domain,
		const set< Identifier > &	attributes,
		VariableDecl &	scope
	)

inline

Get the VariableDecl

Parameters

label	the name of the Variable
type	the type (flow.state,subnode) of the variable
domain	the Domain of the Variable
attributes	the attributes of the Variable
scope	the scope of the Variable. If the scope is VariableDecl(), it is the global scope

Returns: the VariableDecl for this Variable.

Definition at line 655 of file AltaricaModel.hh.

References Diades::Altarica::VariableDeclFactory::getVariableDecl(), and nullVariableDecl().

Referenced by BOOST_AUTO_TEST_CASE().

◆ mainNodeDecl() [1/2]

const NodeDecl& Diades::Altarica::AltaricaModel::mainNodeDecl ( ) const

inline

Returns: the declaration node of 'main'

Definition at line 1056 of file AltaricaModel.hh.

Referenced by BOOST_AUTO_TEST_CASE().

◆ mainNodeDecl() [2/2]

NodeDecl& Diades::Altarica::AltaricaModel::mainNodeDecl ( )

inline

Returns: the declaration node of 'main'

Definition at line 1066 of file AltaricaModel.hh.

◆ mainVariableDecl() [1/2]

const VariableDecl& Diades::Altarica::AltaricaModel::mainVariableDecl ( ) const

inline

get the main Node of the model

Returns: the the main Node of the model.

Todo:: confirm

Returns: the variable declaration associated to the whole model

Definition at line 1031 of file AltaricaModel.hh.

Referenced by BOOST_AUTO_TEST_CASE().

◆ mainVariableDecl() [2/2]

VariableDecl& Diades::Altarica::AltaricaModel::mainVariableDecl ( )

inline

Returns: the variable declaration associated to the whole model

Definition at line 1042 of file AltaricaModel.hh.

◆ name()

const Identifier& Diades::Altarica::AltaricaModel::name ( ) const

inline

Validity of an AltaricaModel

Returns: true if the AltaricaModel is valid

Todo:: implement

Name of the model

Returns: the name of the model

Definition at line 244 of file AltaricaModel.hh.

References _name.

Referenced by getConstant().

◆ newDomain() [1/5]

const Domain& Diades::Altarica::AltaricaModel::newDomain	(	const Identifier &	name,
		const Domain &	associatedDomain,
		NodeDecl &	node
	)

Reference Domain constructor

Parameters

name	an Identifier that represents a Domain (if name is empty, it is considered as a shadow domain)
associatedDomain	the Domain associated to the Identifier name
nodeDecl	the NodeDecl where this Domain is declared

Returns: a Domain defined by the Identifier name in the scope nodeDecl that is equivalent to the Domain associatedDomain

Referenced by BOOST_AUTO_TEST_CASE(), and getIntegers().

◆ newDomain() [2/5]

const Domain& Diades::Altarica::AltaricaModel::newDomain	(	const Identifier &	name,
		const Value &	min,
		const Value &	max,
		NodeDecl &	node
	)

Integer Range Domain constructor

Parameters

name	an Identifier that represents a Domain (if name is empty, it is considered as a shadow domain)
min	the minimal integer bound
max	the maximal integer bound
nodeDecl	the NodeDecl where this Domain is declared

Returns: the integer Domain [min,max] in the scope nodeDecl

◆ newDomain() [3/5]

const Domain& Diades::Altarica::AltaricaModel::newDomain	(	const Identifier &	name,
		const ValueEnumeration &	enumeration,
		NodeDecl &	node
	)

Finite Enumeration Domain constructor

Parameters

name	an Identifier that represents a Domain (if name is empty, it is considered as a shadow domain)
enumeration	the set of Value objects in the enumeration
nodeDecl	the NodeDecl where this Domain is declared

Returns: an enumeration Domain in the scope of nodeDecl

◆ newDomain() [4/5]

const Domain& Diades::Altarica::AltaricaModel::newDomain	(	const Identifier &	name,
		const map< Identifier, Domain::ConstReference > &	structure,
		NodeDecl &	node
	)

Structure Domain constructor

Parameters

name	an Identifier that represents a Domain (if name is empty, it is considered as a shadow domain)
structure	the underlying structure of this Domain
nodeDecl	the NodeDecl where this Domain is declared

Returns: the corresponding structured Domain in the scope nodeDecl.

◆ newDomain() [5/5]

const Domain& Diades::Altarica::AltaricaModel::newDomain	(	const Identifier &	name,
		const Domain &	domain,
		unsigned	size,
		NodeDecl &	node
	)

Array Domain constructor

Parameters

name	an Identifier that represents a Domain (if name is empty, it is considered as a shadow domain)
domain	the domain of any Variable contained in the array
the	size of the array domain
nodeDecl	the NodeDecl where this Domain is declared

Returns: the corresponding array Domain in the scope nodeDecl.

◆ nodeDeclBegin()

NodeDeclIterator Diades::Altarica::AltaricaModel::nodeDeclBegin ( ) const

inline

NodeDecl iterator (begin)

Returns: an iterator on the NodeDecls in the model

Todo:: test

Definition at line 792 of file AltaricaModel.hh.

◆ nodeDeclEnd()

NodeDeclIterator Diades::Altarica::AltaricaModel::nodeDeclEnd ( ) const

inline

NodeDecl iterator (end)

Returns: an iterator on the NodeDecls in the model

Todo:: test

Definition at line 801 of file AltaricaModel.hh.

◆ noMainNodeDecl()

void Diades::Altarica::AltaricaModel::noMainNodeDecl ( )

inline

Set the fact that the model has no main nodes

Definition at line 712 of file AltaricaModel.hh.

References nullNodeDecl().

◆ nullDomain()

const Domain& Diades::Altarica::AltaricaModel::nullDomain ( ) const

inline

Returns: the null domain

Todo:: test

Definition at line 586 of file AltaricaModel.hh.

References Diades::Altarica::DomainFactory::nullDomain().

Referenced by BOOST_AUTO_TEST_CASE().

◆ nullEventDecl() [1/2]

const EventDecl& Diades::Altarica::AltaricaModel::nullEventDecl ( ) const

inline

Returns: the null event declaration

Definition at line 994 of file AltaricaModel.hh.

References Diades::Altarica::EventDeclFactory::nullEventDecl().

◆ nullEventDecl() [2/2]

EventDecl& Diades::Altarica::AltaricaModel::nullEventDecl ( )

inline

Returns: the null event declaration

Definition at line 1004 of file AltaricaModel.hh.

References Diades::Altarica::EventDeclFactory::nullEventDecl().

◆ nullNodeDecl() [1/2]

NodeDecl& Diades::Altarica::AltaricaModel::nullNodeDecl ( )

inline

Returns: the null NodeDecl

Definition at line 760 of file AltaricaModel.hh.

References Diades::Altarica::NodeDeclFactory::nullNodeDecl().

Referenced by noMainNodeDecl().

◆ nullNodeDecl() [2/2]

const NodeDecl& Diades::Altarica::AltaricaModel::nullNodeDecl ( ) const

inline

Returns: the null NodeDecl

Definition at line 771 of file AltaricaModel.hh.

References Diades::Altarica::NodeDeclFactory::nullNodeDecl().

◆ nullParameterDecl()

const ParameterDecl& Diades::Altarica::AltaricaModel::nullParameterDecl ( ) const

inline

Returns: the null Parameter declaration

Definition at line 1101 of file AltaricaModel.hh.

References Diades::Altarica::ParameterDeclFactory::nullParameterDecl().

◆ nullType()

const Type& Diades::Altarica::AltaricaModel::nullType ( ) const

inline

Not a Type

Returns: not a type

Definition at line 284 of file AltaricaModel.hh.

References Diades::Altarica::TypeFactory::nullType().

Referenced by BOOST_AUTO_TEST_CASE(), getArrayType(), and getStructureType().

◆ nullValue()

const Value& Diades::Altarica::AltaricaModel::nullValue ( ) const

inline

Todo:: test

Returns: the null value

Definition at line 378 of file AltaricaModel.hh.

References Diades::Altarica::ValueFactory::nullValue().

Referenced by BOOST_AUTO_TEST_CASE(), getConstant(), and getValue().

◆ nullVariableDecl() [1/2]

const VariableDecl& Diades::Altarica::AltaricaModel::nullVariableDecl ( ) const

inline

Returns: the null declaration

Definition at line 677 of file AltaricaModel.hh.

References Diades::Altarica::VariableDeclFactory::nullVariableDecl().

Referenced by getNodeVariableDecl(), and getVariableDecl().

◆ nullVariableDecl() [2/2]

VariableDecl& Diades::Altarica::AltaricaModel::nullVariableDecl ( )

inline

Returns: the null declaration

Definition at line 688 of file AltaricaModel.hh.

References Diades::Altarica::VariableDeclFactory::nullVariableDecl().

◆ numberOfNodeDecls()

unsigned Diades::Altarica::AltaricaModel::numberOfNodeDecls ( ) const

inline

Returns: the number of nodes declared in the model

Todo:: test

Definition at line 782 of file AltaricaModel.hh.

◆ operator!=()

bool Diades::Altarica::AltaricaModel::operator!= ( const AltaricaModel & model ) const

inline

Difference operator (reference equality)

Parameters

model the AltaricaModel to compare with

Returns: true of both model are not equal (by reference, time-constant)

Definition at line 269 of file AltaricaModel.hh.

◆ operator==()

bool Diades::Altarica::AltaricaModel::operator== ( const AltaricaModel & model ) const

inline

Equality operator (reference equality)

Parameters

model the AltaricaModel to compare with

Returns: true of both model are equal (by reference, time-constant)

Definition at line 257 of file AltaricaModel.hh.

◆ setMainNodeDecl()

void Diades::Altarica::AltaricaModel::setMainNodeDecl ( const Identifier & name )

inline

Set the main node to the given name

Parameters

name	the Identifier of the main node

Definition at line 725 of file AltaricaModel.hh.

References containsNodeDecl(), getNodeDecl(), Diades::Altarica::ExpressionFactory::init(), and Diades::Altarica::EventDeclFactory::init().

Referenced by BOOST_AUTO_TEST_CASE().

◆ typeIndex()

unsigned Diades::Altarica::AltaricaModel::typeIndex ( Domain::DomainType type ) const

private

Parameters

type	a Domain::DomainType

Returns: the index associated to the type.

◆ typeName()

static string Diades::Altarica::AltaricaModel::typeName ( )

inlinestatic

Definition at line 163 of file AltaricaModel.hh.

◆ variableDeclFactory()

const VariableDeclFactory& Diades::Altarica::AltaricaModel::variableDeclFactory ( ) const

inline

Definition at line 695 of file AltaricaModel.hh.

References _varDeclFactory.

Referenced by main().

Member Data Documentation

◆ _constantDictionary

ConstantDictionary Diades::Altarica::AltaricaModel::_constantDictionary

private

_constantDictionary the set of declared constant

Definition at line 145 of file AltaricaModel.hh.

Referenced by constants().

◆ _domainDictionary

DomainDictionary Diades::Altarica::AltaricaModel::_domainDictionary

private

_domainDictionary the dictionary of the global domains

Definition at line 114 of file AltaricaModel.hh.

◆ _domainFactory

DomainFactory Diades::Altarica::AltaricaModel::_domainFactory

private

_domainFactory factory to generate the domains

Definition at line 52 of file AltaricaModel.hh.

◆ _eventFactory

EventDeclFactory Diades::Altarica::AltaricaModel::_eventFactory

mutableprivate

_eventFactory factory to generate the events

Definition at line 73 of file AltaricaModel.hh.

◆ _expressionFactory

ExpressionFactory Diades::Altarica::AltaricaModel::_expressionFactory

private

_expressionFactory factory to generate the expressions

Definition at line 78 of file AltaricaModel.hh.

◆ _globalDomains

vector<Domain::ConstReference> Diades::Altarica::AltaricaModel::_globalDomains

private

_globalDomains the set of global user defined domains

Definition at line 119 of file AltaricaModel.hh.

Referenced by domains().

◆ _mainNodeDecl

vector<NodeDecl::Reference> Diades::Altarica::AltaricaModel::_mainNodeDecl

private

Definition at line 127 of file AltaricaModel.hh.

◆ _mainVariableDecl

vector<VariableDecl::Reference> Diades::Altarica::AltaricaModel::_mainVariableDecl

private

_mainVariableDecl the vector that will contain the global scope variable

Definition at line 64 of file AltaricaModel.hh.

◆ _name

Identifier Diades::Altarica::AltaricaModel::_name

private

_name the name of the model

Definition at line 138 of file AltaricaModel.hh.

Referenced by name().

◆ _nodeDeclFactory

NodeDeclFactory Diades::Altarica::AltaricaModel::_nodeDeclFactory

private

_nodeDeclFactory factory to generate the node declarations

Definition at line 69 of file AltaricaModel.hh.

◆ _nodeDeclOfLabel

NodeDeclDictionary Diades::Altarica::AltaricaModel::_nodeDeclOfLabel

private

_nodeDeclOfLabel the dictionary of node declarations.

Definition at line 133 of file AltaricaModel.hh.

◆ _nodeDecls

NodeDecls Diades::Altarica::AltaricaModel::_nodeDecls

private

_nodeDecls the set of node declarations

Definition at line 126 of file AltaricaModel.hh.

◆ _paramDeclFactory

ParameterDeclFactory Diades::Altarica::AltaricaModel::_paramDeclFactory

private

_varFactory factory to generate the variables (i.e. instances of an VariableDecl) _paramDeclFactory factory to generate the parameters

Definition at line 86 of file AltaricaModel.hh.

◆ _typeFactory

TypeFactory Diades::Altarica::AltaricaModel::_typeFactory

mutableprivate

_typeFactory factory to generate the types

Definition at line 44 of file AltaricaModel.hh.

◆ _valueFactory

ValueFactory Diades::Altarica::AltaricaModel::_valueFactory

mutableprivate

_valueFactory factory to generate the values

Definition at line 48 of file AltaricaModel.hh.

◆ _varDeclFactory

VariableDeclFactory Diades::Altarica::AltaricaModel::_varDeclFactory

private

_varDeclFactory factory to generate the variable declarations

Definition at line 56 of file AltaricaModel.hh.

Referenced by variableDeclFactory().

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

include/diades/altarica/AltaricaModel.hh

Private Attributes
TypeFactory	_typeFactory

ValueFactory	_valueFactory

DomainFactory	_domainFactory

VariableDeclFactory	_varDeclFactory

vector< VariableDecl::Reference >	_mainVariableDecl

NodeDeclFactory	_nodeDeclFactory

EventDeclFactory	_eventFactory

ExpressionFactory	_expressionFactory

ParameterDeclFactory	_paramDeclFactory

DomainDictionary	_domainDictionary

vector< Domain::ConstReference >	_globalDomains

NodeDecls	_nodeDecls

vector< NodeDecl::Reference >	_mainNodeDecl

NodeDeclDictionary	_nodeDeclOfLabel

Identifier	_name

ConstantDictionary	_constantDictionary

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Exception

ExpressionAccessors

Detailed Description

Member Typedef Documentation

◆ ConstantDictionary

◆ ConstPointer

◆ ConstReference

◆ DomainDictionary

◆ Exception

◆ ExprVector

◆ NodeDeclDictionary

◆ NodeDeclIterator

◆ NodeDecls

◆ Pointer

◆ Reference

Constructor & Destructor Documentation

◆ AltaricaModel()

◆ ~AltaricaModel()

Member Function Documentation

◆ addConstant()

◆ constants()

◆ containsNodeDecl()

◆ domains()

◆ getArrayType()

◆ getBinaryExpression()

◆ getBoolean()

◆ getBooleanExpression()

◆ getBooleans()

◆ getCaseExpression()

◆ getConstant()

◆ getDomain() [1/2]

◆ getDomain() [2/2]

◆ getEventDecl() [1/2]

◆ getEventDecl() [2/2]

◆ getIdentifier()

◆ getIdentifierExpression()

◆ getInteger()

◆ getIntegerExpression()

◆ getIntegers()

◆ getIteExpression()

◆ getListExpression()

◆ getNodeDecl()

◆ getNodeVariableDecl()

◆ getParameterDecl()

◆ getStructExpression()

◆ getStructureType()

◆ getUnaryExpression()

◆ getValue() [1/5]

◆ getValue() [2/5]

◆ getValue() [3/5]

◆ getValue() [4/5]

◆ getValue() [5/5]

◆ getVarExpression()

◆ getVariableDecl()

◆ mainNodeDecl() [1/2]

◆ mainNodeDecl() [2/2]

◆ mainVariableDecl() [1/2]

◆ mainVariableDecl() [2/2]

◆ name()

◆ newDomain() [1/5]

◆ newDomain() [2/5]

◆ newDomain() [3/5]

◆ newDomain() [4/5]

◆ newDomain() [5/5]

◆ nodeDeclBegin()

◆ nodeDeclEnd()

◆ noMainNodeDecl()

◆ nullDomain()

◆ nullEventDecl() [1/2]

◆ nullEventDecl() [2/2]

◆ nullNodeDecl() [1/2]

◆ nullNodeDecl() [2/2]

◆ nullParameterDecl()

◆ nullType()

◆ nullValue()

◆ nullVariableDecl() [1/2]