Antares::Data::ScenarioBuilder::Sets Class Reference

Sets for TS numbers, for all years and a single timeseries. More...

#include <sets.h>

Inheritance diagram for Antares::Data::ScenarioBuilder::Sets:

Public Types
using	iterator = Rules::Map::iterator
	Iterator.
using	const_iterator = Rules::Map::const_iterator
	Const iterator.

Public Member Functions
Constructor & Destructor
	Sets ()
	Default constructor.
	~Sets ()
	Destructor.
void	setStudy (Study &study)
Data manupulation
bool	loadFromStudy (Study &study)
	Load data from the study.
void	clear ()
	Clear all data.
template<class StringT >
bool	loadFromINIFile (const StringT &filename)
	Load all rulesets from an INI file.
template<class StringT >
bool	saveToINIFile (const StringT &filename)
	Save all rulesets into a mere INI file.

Public Attributes
bool	inUpdaterMode

Set manipulation
Rules::Ptr	createNew (const RulesScenarioName &name)
	Create a new set.
bool	exists (const RulesScenarioName &lname) const
	Test if a rules set exist.
Rules::Ptr	find (const RulesScenarioName &lname) const
	Find a rule set.
Rules::Ptr	rename (const RulesScenarioName &lname, const RulesScenarioName &newname)
	Rename a given ruleset.
bool	remove (const RulesScenarioName &lname)
	Delete a ruleset.
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
uint	size () const
	Get the number of available sets.
bool	empty () const
	Get if empty.

Detailed Description

Sets for TS numbers, for all years and a single timeseries.

Constructor & Destructor Documentation

Sets()

Antares::Data::ScenarioBuilder::Sets::Sets

(

)

Default constructor.

Parameters

tstype

Type of the timeseries

Member Function Documentation

createNew()

Rules::Ptr Antares::Data::ScenarioBuilder::Sets::createNew

(

const RulesScenarioName &

name

)

Create a new set.

Returns

A non-null pointer if the operation succeeded, null otherwise

exists()

bool Antares::Data::ScenarioBuilder::Sets::exists ( const RulesScenarioName & lname ) const

inline

Test if a rules set exist.

Parameters

lname

Name of the rule set (in lower case)

remove()

bool Antares::Data::ScenarioBuilder::Sets::remove

(

const RulesScenarioName &

lname

)

Delete a ruleset.

Returns

True if the operation suceeded, false otherwise

rename()

Rules::Ptr Antares::Data::ScenarioBuilder::Sets::rename	(	const RulesScenarioName &	lname,
		const RulesScenarioName &	newname )

Rename a given ruleset.

Returns

The object to the ruleset, null if the operation failed

Member Data Documentation

inUpdaterMode

bool Antares::Data::ScenarioBuilder::Sets::inUpdaterMode

Update mode, indicates wether we are called from with a ScenarioBuilderUpdater instance or not

---

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

• src/libs/antares/study/include/antares/study/scenario-builder/sets.h
• src/libs/antares/study/include/antares/study/scenario-builder/sets.hxx
• src/libs/antares/study/scenario-builder/sets.cpp