TargetPriority.h

Go to the documentation of this file.

/*
 * This file is part of ArmarX.
 *
 * ArmarX is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * ArmarX 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/>.
 *
 * @package    view_selection::ArmarXObjects::client
 * @author     Johann Mantel ( j-mantel at gmx dot net )
 * @date       2022
 * @copyright  http://www.gnu.org/licenses/gpl-2.0.txt
 *             GNU General Public License
 */
 
#pragma once
 
#include <iosfwd>
 
#include "AttentionType.h"
 
namespace armarx::view_selection::gaze_targets
{
    /**
 * @defgroup Library-client objects
 * @ingroup view_selection
 *
 * @class TargetPriority
 * @ingroup Library-client
 * @brief The Priority of a GazeTarget
 */
    class TargetPriority
    {
    public:
        TargetPriority(const AttentionType& attentionType = AttentionType::RandomEvent,
                       double priority = -1);
 
        bool operator<(const TargetPriority& rhs) const;
 
        bool operator<=(const TargetPriority& rhs) const;
 
        bool operator==(const TargetPriority& rhs) const;
 
        bool operator!=(const TargetPriority& rhs) const;
 
        bool operator>=(const TargetPriority& rhs) const;
 
        bool operator>(const TargetPriority& rhs) const;
 
    public:
        /// The type of attention, defining the first level of priority
        AttentionType attentionType;
        /// The priority among GazeTargets of same AttentionType
        double priority;
    };
 
    std::ostream& operator<<(std::ostream& os, const TargetPriority& prio);
 
} // namespace armarx::view_selection::gaze_targets