Antares::ModelerStudy::SystemModel::ComponentBuilder Class Reference

Public Member Functions
ComponentBuilder &	withId (std::string_view id)
	Sets the ID of the component. More...
ComponentBuilder &	withModel (const Model *model)
	Sets the model of the component. More...
ComponentBuilder &	withIndex (unsigned int index)
ComponentBuilder &	withParameterValues (std::map< std::string, ParameterTypeAndValue > parameter_values)
	Sets the parameter values of the component. The parameters included should be all of the model's parameters. More...
ComponentBuilder &	withScenarioGroupId (const std::string &scenario_group_id)
	Sets the ID of the scenario group to which the component belongs. More...
Component	build ()
	Builds and returns the Component object. More...

Member Function Documentation

build()

Component Antares::ModelerStudy::SystemModel::ComponentBuilder::build

(

)

Builds and returns the Component object.

Returns

The constructed Component object.

withId()

ComponentBuilder & Antares::ModelerStudy::SystemModel::ComponentBuilder::withId

(

std::string_view

id

)

Sets the ID of the component.

Parameters

id	The ID to set.

Returns

Reference to the ComponentBuilder object.

withModel()

ComponentBuilder & Antares::ModelerStudy::SystemModel::ComponentBuilder::withModel

(

const Model *

model

)

Sets the model of the component.

Parameters

model

The model to set.

Returns

Reference to the ComponentBuilder object.

withParameterValues()

ComponentBuilder & Antares::ModelerStudy::SystemModel::ComponentBuilder::withParameterValues

(

std::map< std::string, ParameterTypeAndValue >

parameter_values

)

Sets the parameter values of the component. The parameters included should be all of the model's parameters.

Parameters

parameter_values

The map of parameter values to set.

Returns

Reference to the ComponentBuilder object.

withScenarioGroupId()

ComponentBuilder & Antares::ModelerStudy::SystemModel::ComponentBuilder::withScenarioGroupId

(

const std::string &

scenario_group_id

)

Sets the ID of the scenario group to which the component belongs.

Parameters

scenario_group_id

The scenario group ID to set.

Returns

Reference to the ComponentBuilder object.

---

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

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