Antares::ModelerStudy::SystemModel::LibraryBuilder Class Reference

Builder for the Library class Follow builder pattern: builder.Library().withId("id").withDescription("description").withPortTypes(portList).withModels(modelList).build();. More...

#include <library.h>

Public Member Functions
LibraryBuilder &	withId (const std::string &id)
	Sets the ID of the library. More...
LibraryBuilder &	withDescription (const std::string &description)
	Sets the description of the library. More...
LibraryBuilder &	withPortTypes (std::vector< PortType > &&portTypes)
	Sets the port types of the library. More...
LibraryBuilder &	withModels (std::vector< Model > &&models)
	Sets the models of the library. More...
const Library &	build () const
	Returns the Library object. More...

Detailed Description

Builder for the Library class Follow builder pattern: builder.Library().withId("id").withDescription("description").withPortTypes(portList).withModels(modelList).build();.

Member Function Documentation

build()

const Library & Antares::ModelerStudy::SystemModel::LibraryBuilder::build

(

)

const

Returns the Library object.

Returns

The constructed Library object.

withDescription()

LibraryBuilder & Antares::ModelerStudy::SystemModel::LibraryBuilder::withDescription

(

const std::string &

description

)

Sets the description of the library.

Parameters

description

The description to set.

Returns

Reference to the LibraryBuilder object.

withId()

LibraryBuilder & Antares::ModelerStudy::SystemModel::LibraryBuilder::withId

(

const std::string &

id

)

Sets the ID of the library.

Parameters

id	The ID to set.

Returns

Reference to the LibraryBuilder object.

withModels()

LibraryBuilder & Antares::ModelerStudy::SystemModel::LibraryBuilder::withModels

(

std::vector< Model > &&

models

)

Sets the models of the library.

Parameters

models

A vector of Model objects to set.

Returns

Reference to the LibraryBuilder object.

inputs it not garanteed to be valid after the call

withPortTypes()

LibraryBuilder & Antares::ModelerStudy::SystemModel::LibraryBuilder::withPortTypes

(

std::vector< PortType > &&

portTypes

)

Sets the port types of the library.

Parameters

portTypes

A vector of PortType objects to set.

Returns

Reference to the LibraryBuilder object.

inputs it not garanteed 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/library.h
• src/study/system-model/library.cpp