Antares Simulator
Power System Simulator
Public Types | Static Public Attributes | List of all members
Antares::Solver::Variable::Economy::VCardTimeSeriesBase< TraitsType > Struct Template Reference

VCard template providing variable metadata and configuration. More...

#include <timeseries_base.h>

Inheritance diagram for Antares::Solver::Variable::Economy::VCardTimeSeriesBase< TraitsType >:
Antares::Solver::Variable::Economy::TimeSeriesTraits< TraitsType >

Public Types

using BaseType = TimeSeriesTraits< TraitsType >
 Base traits type.
 
using VCardForSpatialAggregate = VCardTimeSeriesBase< TraitsType >
 Self-reference for spatial aggregation.
 
Type Definitions
using ResultsType = typename BaseType::ResultsType
 
using IntermediateValuesBaseType = typename BaseType::IntermediateValuesBaseType
 
using IntermediateValuesType = typename BaseType::IntermediateValuesType
 
using IntermediateValuesTypeForSpatialAg = typename BaseType::IntermediateValuesTypeForSpatialAg
 
- Public Types inherited from Antares::Solver::Variable::Economy::TimeSeriesTraits< TraitsType >
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 Member Functions

Legacy API (backward compatibility)
static std::string Caption ()
 Get variable caption as std::string. More...
 
static std::string Unit ()
 Get variable unit as std::string. More...
 
static std::string Description ()
 Get variable description as std::string. More...
 

Static Public Attributes

static constexpr std::string_view kCaption = TraitsType::kCaption
 Modern C++20 API: compile-time string views.
 
static constexpr std::string_view kUnit = BaseType::kUnit
 
static constexpr std::string_view kDescription = TraitsType::kDescription
 
- Static Public Attributes inherited from Antares::Solver::Variable::Economy::TimeSeriesTraits< TraitsType >
static constexpr std::string_view kUnit
 Unit for all time series variables.
 
static constexpr uint8_t categoryDataLevel
 Data aggregation level (area-based)
 
static constexpr uint8_t categoryFileLevel
 File output level configuration.
 
static constexpr uint8_t precision
 Precision settings for output.
 
static constexpr uint8_t nodeDepthForGUI
 GUI indentation level.
 
static constexpr uint8_t decimal
 Decimal precision for display.
 
static constexpr int columnCount
 Number of columns in output (typically 1 for time series)
 
static constexpr uint8_t spatialAggregate
 Spatial aggregation method (sum across areas)
 
static constexpr uint8_t spatialAggregateMode
 Spatial aggregation mode (each year separately)
 
static constexpr uint8_t spatialAggregatePostProcessing
 Post-processing for spatial aggregation.
 
static constexpr uint8_t hasIntermediateValues
 Whether intermediate values are computed.
 
static constexpr uint8_t isPossiblyNonApplicable
 Whether variable can be non-applicable.
 

Detailed Description

template<typename TraitsType>
struct Antares::Solver::Variable::Economy::VCardTimeSeriesBase< TraitsType >

VCard template providing variable metadata and configuration.

  • This template creates a VCard (Variable Card) that describes a time series variable. It combines the common traits with specific traits provided by the TraitsType parameter.
  • Template Parameters
    TraitsTypeSpecific traits defining caption, description, and any custom properties

Member Function Documentation

◆ Caption()

template<typename TraitsType >
static std::string Antares::Solver::Variable::Economy::VCardTimeSeriesBase< TraitsType >::Caption ( )
inlinestatic

Get variable caption as std::string.

Returns
Variable caption (e.g., "SOLAR", "WIND", "LOAD")

◆ Description()

template<typename TraitsType >
static std::string Antares::Solver::Variable::Economy::VCardTimeSeriesBase< TraitsType >::Description ( )
inlinestatic

Get variable description as std::string.

Returns
Detailed description of the variable

◆ Unit()

template<typename TraitsType >
static std::string Antares::Solver::Variable::Economy::VCardTimeSeriesBase< TraitsType >::Unit ( )
inlinestatic

Get variable unit as std::string.

Returns
Variable unit ("MWh")
The documentation for this struct was generated from the following file: