Alexandria 2.31.0
SDC-CH common library for the Euclid project
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Euclid::XYDataset::FileParser Class Referenceabstract

#include <FileParser.h>

Inheritance diagram for Euclid::XYDataset::FileParser:
Inheritance graph
[legend]

Public Member Functions

virtual std::string getName (const std::string &file)=0
 Get the dataset name or identifier from a file.
 
virtual std::string getParameter (const std::string &file, const std::string &key_word)=0
 Get the parameter identified by a given key_word value from a file.
 
virtual std::unique_ptr< XYDatasetgetDataset (const std::string &file)=0
 Get the dataset from a file.
 
virtual bool isDatasetFile (const std::string &file)=0
 Check that we are in presence of a dataset file.
 
virtual ~FileParser ()=default
 Default destructor.
 

Detailed Description

Interface class @ brief Interface class which permits to get a dataset name (identifier) and the data itself stored into a XYDataset object.

Definition at line 42 of file FileParser.h.

Constructor & Destructor Documentation

◆ ~FileParser()

virtual Euclid::XYDataset::FileParser::~FileParser ( )
virtualdefault

Default destructor.

Member Function Documentation

◆ getDataset()

virtual std::unique_ptr< XYDataset > Euclid::XYDataset::FileParser::getDataset ( const std::string file)
pure virtual

Get the dataset from a file.

Parameters
fileFilename including absolute path
Returns
A unique pointer of a XYDataset object or a null pointer

Implemented in Euclid::XYDataset::AsciiParser, and Euclid::XYDataset::FitsParser.

◆ getName()

virtual std::string Euclid::XYDataset::FileParser::getName ( const std::string file)
pure virtual

Get the dataset name or identifier from a file.

Parameters
fileFilename including absolute path
Returns
A dataset name

Implemented in Euclid::XYDataset::AsciiParser, and Euclid::XYDataset::FitsParser.

◆ getParameter()

virtual std::string Euclid::XYDataset::FileParser::getParameter ( const std::string file,
const std::string key_word 
)
pure virtual

Get the parameter identified by a given key_word value from a file.

Parameters
fileFilename including absolute path
key_wordkey word identifying the parameter
Returns
A dataset name

Implemented in Euclid::XYDataset::AsciiParser, and Euclid::XYDataset::FitsParser.

◆ isDatasetFile()

virtual bool Euclid::XYDataset::FileParser::isDatasetFile ( const std::string file)
pure virtual

Check that we are in presence of a dataset file.

Parameters
fileFilename including the absolute path
Returns
true: it is file containing datasets

Implemented in Euclid::XYDataset::AsciiParser, and Euclid::XYDataset::FitsParser.


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