Antares::ModelerStudy::SystemModel::ModelBuilder Class Reference

Public Member Functions
ModelBuilder &	withId (std::string_view id)
	Sets the ID of the model. More...
ModelBuilder &	withObjectives (std::vector< Objective > &&objectives)
	Sets the objectives of the model. More...
ModelBuilder &	withParameters (std::vector< Parameter > &&parameters)
	Sets the parameters of the model. More...
ModelBuilder &	withVariables (std::vector< Variable > &&variables)
	Sets the variables of the model. More...
ModelBuilder &	withPorts (std::vector< Port > &&ports)
	Sets the ports of the model. More...
ModelBuilder &	withConstraints (std::vector< Constraint > &&constraints)
	Sets the constraints of the model. More...
ModelBuilder &	withPortFieldDefinitions (std::vector< PortFieldDefinition > &&portFieldDefinitions)
	Sets the port-field definitions of the model. More...
ModelBuilder &	withExtraOutputs (std::vector< ExtraOutput > &&extraOutputs)
	Sets the extra outputs of the model. More...
Model	build ()
	Builds and returns the Model object. More...

Member Function Documentation

build()

Model Antares::ModelerStudy::SystemModel::ModelBuilder::build

(

)

Builds and returns the Model object.

Returns

The constructed Model object.

withConstraints()

ModelBuilder & Antares::ModelerStudy::SystemModel::ModelBuilder::withConstraints

(

std::vector< Constraint > &&

constraints

)

Sets the constraints of the model.

Parameters

constraints

A vector of Constraint objects to set.

Returns

Reference to the ModelBuilder object.

inputs are not guaranteed to be valid after the call

withExtraOutputs()

ModelBuilder & Antares::ModelerStudy::SystemModel::ModelBuilder::withExtraOutputs

(

std::vector< ExtraOutput > &&

extraOutputs

)

Sets the extra outputs of the model.

Parameters

extraOutputs

A vector of ExtraOutput objects to set.

Returns

Reference to the ModelBuilder object.

inputs are not guaranteed to be valid after the call

withId()

ModelBuilder & Antares::ModelerStudy::SystemModel::ModelBuilder::withId

(

std::string_view

id

)

Sets the ID of the model.

Parameters

id	The ID to set.

Returns

Reference to the ModelBuilder object.

withObjectives()

ModelBuilder & Antares::ModelerStudy::SystemModel::ModelBuilder::withObjectives

(

std::vector< Objective > &&

objectives

)

Sets the objectives of the model.

Parameters

parameters

A vector of Objective objects to set.

Returns

Reference to the ModelBuilder object.

withParameters()

ModelBuilder & Antares::ModelerStudy::SystemModel::ModelBuilder::withParameters

(

std::vector< Parameter > &&

parameters

)

Sets the parameters of the model.

Parameters

parameters

A vector of Parameter objects to set.

Returns

Reference to the ModelBuilder object.

inputs are not guaranteed to be valid after the call

withPortFieldDefinitions()

ModelBuilder & Antares::ModelerStudy::SystemModel::ModelBuilder::withPortFieldDefinitions

(

std::vector< PortFieldDefinition > &&

portFieldDefinitions

)

Sets the port-field definitions of the model.

Parameters

portFieldDefinitions

A vector of PortFieldDefinition objects to set.

Returns

Reference to the ModelBuilder object.

inputs are not guaranteed to be valid after the call

withPorts()

ModelBuilder & Antares::ModelerStudy::SystemModel::ModelBuilder::withPorts

(

std::vector< Port > &&

ports

)

Sets the ports of the model.

Parameters

ports

A vector of Port objects to set.

Returns

Reference to the ModelBuilder object.

inputs are not garanteed to be valid after the call

withVariables()

ModelBuilder & Antares::ModelerStudy::SystemModel::ModelBuilder::withVariables

(

std::vector< Variable > &&

variables

)

Sets the variables of the model.

Parameters

variables

A vector of Variable objects to set.

Returns

Reference to the ModelBuilder object.

inputs are not guaranteed to be valid after the call

---

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

• src/study/system-model/include/antares/study/system-model/model.h
• src/study/system-model/model.cpp