HLCC Documentation 2.2.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
hlcc::telif::DataAcquisitionList Class Reference

#include <dataAcquisition.hpp>

Public Member Functions

 DataAcquisitionList ()
 
int GetNumberAcquisitions ()
 
std::shared_ptr< DataAcquisitionGetAcquisition (const std::string &given_id)
 
std::shared_ptr< DataAcquisitionCreateAcquisition (OldbInterface &moldbif, std::string given_id)
 
bool RemoveAcquisition (const std::string &given_id)
 
 DataAcquisitionList (const DataAcquisitionList &)=delete
 
DataAcquisitionListoperator= (const DataAcquisitionList &)=delete
 Disable copy constructor.
 

Detailed Description

This class contains the management of data acquisitions list.

Constructor & Destructor Documentation

◆ DataAcquisitionList() [1/2]

hlcc::telif::DataAcquisitionList::DataAcquisitionList ( )

Default Constructor.

◆ DataAcquisitionList() [2/2]

hlcc::telif::DataAcquisitionList::DataAcquisitionList ( const DataAcquisitionList & )
delete

Member Function Documentation

◆ CreateAcquisition()

std::shared_ptr< DataAcquisition > hlcc::telif::DataAcquisitionList::CreateAcquisition ( OldbInterface & moldbif,
std::string given_id = "" )

Creates a new acquisition using the with the given id

Parameters
[in]moldbifOldb interface.
[in]given_idcontaining id for new acquisition.
Returns
shared pointer to the just created acquisition or nullptr if given id already in the list.
Exceptions
std::runtime_errorwhen it fails to create aquisition.

◆ GetAcquisition()

std::shared_ptr< DataAcquisition > hlcc::telif::DataAcquisitionList::GetAcquisition ( const std::string & given_id)

Retrieves from the aquisition list reference to the acquisition that matches the given id.

Parameters
[in]given_idstring containing id to match.
Returns
shared pointer to the matching acquisition or nullptr if not found.

◆ GetNumberAcquisitions()

int hlcc::telif::DataAcquisitionList::GetNumberAcquisitions ( )

Check the number of acquisitions in the list.

Returns
integer with the number of acquisitions in the list.

◆ operator=()

DataAcquisitionList & hlcc::telif::DataAcquisitionList::operator= ( const DataAcquisitionList & )
delete

Disable copy constructor.

◆ RemoveAcquisition()

bool hlcc::telif::DataAcquisitionList::RemoveAcquisition ( const std::string & given_id)

Removes acquisition matching given id

Parameters
[in]given_idstring containing id for acquisition to delete.
Returns
true if successfully removed acquisition or false if id not in the list.

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