Topology.h

Go to the documentation of this file.

// Copyright 2014 GSI, Inc. All rights reserved.
//
//
//

#ifndef DDS_TOPOLOGY_H
#define DDS_TOPOLOGY_H

// STD
#include <memory>
// DDS
#include "TopoCollection.h"
#include "TopoGroup.h"
#include "TopoTask.h"

namespace dds
{
    namespace topology_api
    {
        class CTopoCore;

        class CTopology
        {
          public:
            CTopology();

            ~CTopology();

            CTopology(const std::string& _fileName, const std::string& _schemaFileName = "");

            CTopology(std::istream& _stream, const std::string& _schemaFileName = "");

            std::string getName() const;

            std::string getFilepath() const;

            uint32_t getHash() const;

            CTopoGroup::Ptr_t getMainGroup() const;

            const STopoRuntimeTask& getRuntimeTaskById(Id_t _id) const;

            const STopoRuntimeCollection& getRuntimeCollectionById(Id_t _id) const;

            const STopoRuntimeTask& getRuntimeTaskByIdPath(const std::string& _idPath) const;

            const STopoRuntimeCollection& getRuntimeCollectionByIdPath(const std::string& _idPath) const;

            const STopoRuntimeTask& getRuntimeTask(const std::string& _path) const;

            const STopoRuntimeCollection& getRuntimeCollection(const std::string& _path) const;

            STopoRuntimeTask::FilterIteratorPair_t getRuntimeTaskIterator(
                STopoRuntimeTask::Condition_t _condition = nullptr) const;

            STopoRuntimeCollection::FilterIteratorPair_t getRuntimeCollectionIterator(
                STopoRuntimeCollection::Condition_t _condition = nullptr) const;

            STopoRuntimeTask::FilterIteratorPair_t getRuntimeTaskIteratorMatchingPath(
                const std::string& _pathPattern) const;

            STopoRuntimeCollection::FilterIteratorPair_t getRuntimeCollectionIteratorMatchingPath(
                const std::string& _pathPattern) const;

            std::pair<size_t, size_t> getRequiredNofAgents(size_t _defaultNumSlots) const;

            size_t getRequiredNofAgents() const;

            size_t getTotalNofTasks() const;

          private:
            std::shared_ptr<CTopoCore> m_topo;
        };
    } // namespace topology_api
} // namespace dds

#endif /* DDS_TOPOLOGY_H */