Antares::Solver::Variable::Economy::TimeSeriesTraits< Derived > Struct Template Reference

Base traits template providing common properties for all time series variables. More...

#include <timeseries_base.h>

Public Types
using	ResultsType = Results< R::AllYears::Average< R::AllYears::StdDeviation< R::AllYears::Min< R::AllYears::Max<> >> >>
	Results configuration: Average, StdDev, Min, Max across all years.
using	IntermediateValuesBaseType = IntermediateValues
	Base type for intermediate values storage.
using	IntermediateValuesType = std::vector< IntermediateValues >
	Container for intermediate values (one per parallel space)
using	IntermediateValuesTypeForSpatialAg = std::unique_ptr< IntermediateValuesBaseType[]>
	Pointer type for spatial aggregation.

Static Public Attributes
static constexpr std::string_view	kUnit = "MWh"
	Unit for all time series variables.
static constexpr uint8_t	categoryDataLevel = Category::DataLevel::area
	Data aggregation level (area-based)
static constexpr uint8_t	categoryFileLevel
	File output level configuration. More...
static constexpr uint8_t	precision = Category::all
	Precision settings for output.
static constexpr uint8_t	nodeDepthForGUI = 0
	GUI indentation level.
static constexpr uint8_t	decimal = 0
	Decimal precision for display.
static constexpr int	columnCount = 1
	Number of columns in output (typically 1 for time series)
static constexpr uint8_t	spatialAggregate = Category::spatialAggregateSum
	Spatial aggregation method (sum across areas)
static constexpr uint8_t	spatialAggregateMode = Category::spatialAggregateEachYear
	Spatial aggregation mode (each year separately)
static constexpr uint8_t	spatialAggregatePostProcessing = 0
	Post-processing for spatial aggregation.
static constexpr uint8_t	hasIntermediateValues = 1
	Whether intermediate values are computed.
static constexpr uint8_t	isPossiblyNonApplicable = 0
	Whether variable can be non-applicable.

Detailed Description

template<typename Derived>
struct Antares::Solver::Variable::Economy::TimeSeriesTraits< Derived >

Base traits template providing common properties for all time series variables.

• This template provides default values for VCard properties that are common across all time series variables. Derived traits only need to specify what makes them unique.

• Template Parameters

  Derived

  The derived traits type (CRTP pattern)

• ## Common Properties Provided:
• Unit: "MWh" for all time series
• Data level: Area-level aggregation
• File output configuration
• Spatial aggregation settings
• Intermediate values configuration
• ## Type Definitions:
• ResultsType: Configured for average, std deviation, min, max across all years
• IntermediateValuesType: Vector of intermediate values for parallel processing

Member Data Documentation

categoryFileLevel

template<typename Derived >

constexpr uint8_t Antares::Solver::Variable::Economy::TimeSeriesTraits< Derived >::categoryFileLevel

staticconstexpr

Initial value:

= ResultsType::categoryFile
                                                 & (Category::FileLevel::id
                                                    | Category::FileLevel::va)

File output level configuration.

---

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

• src/solver/variable/include/antares/solver/variable/commons/timeseries_base.h