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::XYDatasetProvider Class Referenceabstract

This interface class provides the dataset following a qualified name object. More...

#include <XYDatasetProvider.h>

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

Public Member Functions

virtual std::vector< QualifiedNamelistContents (const std::string &group)=0
 Virtual function to list all files contents in the "group" path.
 
virtual std::string getParameter (const QualifiedName &qualified_name, const std::string &key_word)=0
 
virtual std::unique_ptr< XYDatasetgetDataset (const QualifiedName &qualified_name)=0
 Virtual function for getting from a qualified name the dataset of XYDataset type.
 
virtual ~XYDatasetProvider ()=default
 

Detailed Description

This interface class provides the dataset following a qualified name object.

Interface class

This class consists of two virtual functions, listContents and getDataset. The listContents function lists all files contents in the "group" path and the getDatatset function gets from a qualified name the dataset of a XYDataset type.

Definition at line 49 of file XYDatasetProvider.h.

Constructor & Destructor Documentation

◆ ~XYDatasetProvider()

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

Member Function Documentation

◆ getDataset()

virtual std::unique_ptr< XYDataset > Euclid::XYDataset::XYDatasetProvider::getDataset ( const QualifiedName qualified_name)
pure virtual

Virtual function for getting from a qualified name the dataset of XYDataset type.

Parameters
qualified_nameQualified name of the dataset
Returns
A unique pointer of XYDataset type to the dataset

Implemented in Euclid::XYDataset::CachedProvider, and Euclid::XYDataset::FileSystemProvider.

◆ getParameter()

virtual std::string Euclid::XYDataset::XYDatasetProvider::getParameter ( const QualifiedName qualified_name,
const std::string key_word 
)
pure virtual

◆ listContents()

virtual std::vector< QualifiedName > Euclid::XYDataset::XYDatasetProvider::listContents ( const std::string group)
pure virtual

Virtual function to list all files contents in the "group" path.

let's take the following example. if you have a group sets to "A/B/C" and under the "C" repository there is the following structure : C/file1 C/file2 C/D/file3 etc... then the vector of strings returned will contain the following elements: vector[0] = "A/B/C/file1" vector[1] = "A/B/C/file2" vector[3] = "A/B/C/D/file3" etc... Note: The empty string for the group means the root group

Parameters
groupName of the dataset group
Returns
A vector of the qualified names of all datasets inside the given group (recursively)

Implemented in Euclid::XYDataset::CachedProvider, and Euclid::XYDataset::FileSystemProvider.


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