mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 00:31:14 +00:00
69 lines
2.0 KiB
C++
69 lines
2.0 KiB
C++
/********************************************************************************
|
|
* Copyright (C) 2019 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *
|
|
* *
|
|
* This software is distributed under the terms of the *
|
|
* GNU Lesser General Public Licence (LGPL) version 3, *
|
|
* copied verbatim in the file "LICENSE" *
|
|
********************************************************************************/
|
|
|
|
#ifndef FAIR_MQ_SDK_DDSTOPOLOGY_H
|
|
#define FAIR_MQ_SDK_DDSTOPOLOGY_H
|
|
|
|
#include <boost/filesystem.hpp>
|
|
#include <fairmq/sdk/DDSEnvironment.h>
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
namespace fair {
|
|
namespace mq {
|
|
namespace sdk {
|
|
|
|
/**
|
|
* @class DDSTopology DDSTopology.h <fairmq/sdk/DDSTopology.h>
|
|
* @brief Represents a DDS topology
|
|
*/
|
|
class DDSTopology
|
|
{
|
|
public:
|
|
using Path = boost::filesystem::path;
|
|
|
|
DDSTopology() = delete;
|
|
|
|
/// @brief Construct from file
|
|
/// @param topoFile DDS topology xml file
|
|
/// @param env DDS environment
|
|
explicit DDSTopology(Path topoFile, DDSEnvironment env = DDSEnvironment());
|
|
|
|
/// @brief Get associated DDS environment
|
|
auto GetEnv() const -> DDSEnvironment;
|
|
|
|
/// @brief Get path to DDS topology xml, if it is known
|
|
/// @throw std::runtime_error
|
|
auto GetTopoFile() const -> Path;
|
|
|
|
void CreateTopology(Path);
|
|
|
|
/// @brief Get number of required agents for this topology
|
|
int GetNumRequiredAgents();
|
|
|
|
/// @brief Get list of devices
|
|
std::vector<uint64_t> GetDeviceList();
|
|
|
|
/// @brief Get the name of the topology
|
|
// auto GetName() const -> std::string;
|
|
|
|
friend auto operator<<(std::ostream&, const DDSTopology&) -> std::ostream&;
|
|
|
|
private:
|
|
struct Impl;
|
|
std::shared_ptr<Impl> fImpl;
|
|
};
|
|
|
|
using DDSTopo = DDSTopology;
|
|
|
|
} // namespace sdk
|
|
} // namespace mq
|
|
} // namespace fair
|
|
|
|
#endif /* FAIR_MQ_SDK_DDSTOPOLOGY_H */
|