Mantid
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
Mantid::API::IJournal Class Referenceabstract

IJournal: Interface for classes that fetch information from journal files. More...

#include <IJournal.h>

Inheritance diagram for Mantid::API::IJournal:
Mantid::DataHandling::ISISJournal

Public Types

using RunData = std::map< std::string, std::string >
 

Public Member Functions

virtual std::vector< std::string > getCycleNames ()=0
 Get the list of cycle names. More...
 
virtual std::vector< RunDatagetRuns (std::vector< std::string > const &valuesToLookup={}, RunData const &filters=RunData())=0
 Get data for runs that match the given filters. More...
 
 IJournal ()=default
 
 IJournal (IJournal &&rhs)
 
 IJournal (IJournal const &rhs)=delete
 
IJournaloperator= (IJournal &&rhs)
 
IJournal const & operator= (IJournal const &rhs)=delete
 
virtual ~IJournal ()
 

Detailed Description

IJournal: Interface for classes that fetch information from journal files.

Definition at line 19 of file IJournal.h.

Member Typedef Documentation

◆ RunData

using Mantid::API::IJournal::RunData = std::map<std::string, std::string>

Definition at line 21 of file IJournal.h.

Constructor & Destructor Documentation

◆ IJournal() [1/3]

Mantid::API::IJournal::IJournal ( )
default

◆ ~IJournal()

Mantid::API::IJournal::~IJournal ( )
virtualdefault

◆ IJournal() [2/3]

Mantid::API::IJournal::IJournal ( IJournal const &  rhs)
delete

◆ IJournal() [3/3]

Mantid::API::IJournal::IJournal ( IJournal &&  rhs)
default

Member Function Documentation

◆ getCycleNames()

virtual std::vector< std::string > Mantid::API::IJournal::getCycleNames ( )
pure virtual

Get the list of cycle names.

Implemented in Mantid::DataHandling::ISISJournal.

◆ getRuns()

virtual std::vector< RunData > Mantid::API::IJournal::getRuns ( std::vector< std::string > const &  valuesToLookup = {},
RunData const &  filters = RunData() 
)
pure virtual

Get data for runs that match the given filters.

Implemented in Mantid::DataHandling::ISISJournal.

◆ operator=() [1/2]

IJournal & Mantid::API::IJournal::operator= ( IJournal &&  rhs)
default

◆ operator=() [2/2]

IJournal const & Mantid::API::IJournal::operator= ( IJournal const &  rhs)
delete

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