CollectiveCommunicationEvent.hpp

/*
 * Marvelous OTF2 Traces Interactive Visualizer (MOTIV)
 * Copyright (C) 2023 Florian Gallrein, Björn Gehrke
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef MOTIV_COLLECTIVECOMMUNICATIONEVENT_HPP
#define MOTIV_COLLECTIVECOMMUNICATIONEVENT_HPP
 
 
#include "CommunicationEvent.hpp"
 
#include <utility>
 
class CollectiveCommunicationEvent : public CommunicationEvent {
public:
    class Member {
    public:
        Member(const otf2::chrono::duration &start,
               const otf2::chrono::duration &anEnd,
               otf2::definition::location *location) :
               start(start), end(anEnd), location(location) {}
 
    public:
        const otf2::chrono::duration start; 
        const otf2::chrono::duration end; 
        const otf2::definition::location* location; 
    public:
        [[nodiscard]] const otf2::chrono::duration &getStart() const {
            return start;
        }
 
        [[nodiscard]] const otf2::chrono::duration &getEnd() const {
            return end;
        }
 
        [[nodiscard]] const otf2::definition::location * getLocation() const {
            return location;
        }
 
        BUILDER(Member,
                BUILDER_FIELD(otf2::chrono::duration, start)
                BUILDER_FIELD(otf2::chrono::duration, end)
                BUILDER_FIELD(otf2::definition::location*, location),
                start, end, location)
    };
 
public:
    CollectiveCommunicationEvent(std::vector<Member *> members,
                                 otf2::definition::location *location,
                                 types::communicator *communicator,
                                 otf2::collective_type operation,
                                 uint32_t root);
    ~CollectiveCommunicationEvent() override = default;
 
    [[nodiscard]] otf2::definition::location * getLocation() const override;
 
    [[nodiscard]] otf2::chrono::duration getStartTime() const override;
 
    [[nodiscard]] otf2::chrono::duration getEndTime() const override;
 
    [[nodiscard]] types::communicator * getCommunicator() const override;
 
    [[nodiscard]] CommunicationKind getKind() const override;
 
    [[nodiscard]] otf2::collective_type getOperation() const;
 
    [[nodiscard]] uint32_t getRoot() const;
 
    [[nodiscard]] const std::vector<Member *> &getMembers() const;
 
    BUILDER(CollectiveCommunicationEvent,
            BUILDER_FIELD(std::vector<Member*>, members)
                BUILDER_FIELD(otf2::definition::location*, location)
                BUILDER_FIELD(types::communicator*, communicator)
                BUILDER_FIELD(otf2::collective_type, operation)
                BUILDER_FIELD(uint32_t, root),
            members, location, communicator, operation, root)
 
private:
    otf2::chrono::duration start{};
    otf2::chrono::duration end{};
    otf2::definition::location* location;
    std::vector<Member*> members;
    types::communicator* communicator;
    otf2::common::collective_type operation;
    std::uint32_t root;
};
 
 
#endif //MOTIV_COLLECTIVECOMMUNICATIONEVENT_HPP