Antares Xpansion
Investment simulations for Antares studies
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
LinkdataRecord Struct Reference

struct describing a line in a linkdata file of antares More...

#include <LinkdataRecord.h>

Classes

struct  FileColumns
 

Public Member Functions

 LinkdataRecord ()
 LinkdataRecord constructor.
 
 LinkdataRecord (const FileColumns &afileColumns)
 LinkdataRecord constructor versions.
 
std::string to_row (std::string const &sep_p) const
 returns a one-line string describing the LinkdataRecord
 
void updateCapacities (double directCapacity_p, double indirectCapacity_p)
 update the capacities of the LinkdataRecord
 
void fillFromRow (std::string const &line_p)
 populates the LinkdataRecord attributes for a string
 
void reset ()
 reset the LinkdataRecord attributes to 0
 

Public Attributes

FileColumns fileColumns
 

Detailed Description

struct describing a line in a linkdata file of antares

Constructor & Destructor Documentation

◆ LinkdataRecord()

LinkdataRecord::LinkdataRecord ( const FileColumns &  afileColumns)
explicit

LinkdataRecord constructor versions.

Parameters
fileColumns: LinkdataRecord::FileColumns object that hold columns infos of the file

Member Function Documentation

◆ fillFromRow()

void LinkdataRecord::fillFromRow ( std::string const &  line_p)

populates the LinkdataRecord attributes for a string

Parameters
line_p: string describing the record

◆ to_row()

std::string LinkdataRecord::to_row ( std::string const &  sep_p) const

returns a one-line string describing the LinkdataRecord

Parameters
sep_p: delimiter used to separate record's attributes in the created line string

◆ updateCapacities()

void LinkdataRecord::updateCapacities ( double  directCapacity_p,
double  indirectCapacity_p 
)

update the capacities of the LinkdataRecord

Parameters
directCapacity_p: value to set to fileColumns.directCapacity_
indirectCapacity_p: value to set to fileColumns.indirectCapacity_
The documentation for this struct was generated from the following files: