ITerminalNodePolicy.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   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 2 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, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_MULTI_DIM_FUNCTION_GRAPH_INTERFACE_TERMINAL_NODE_POLICY_H
#define GUM_MULTI_DIM_FUNCTION_GRAPH_INTERFACE_TERMINAL_NODE_POLICY_H

#include <agrum/graphs/parts/nodeGraphPart.h>

namespace gum {

  // clang-format off
  template <typename GUM_SCALAR>
  class ITerminalNodePolicy {

    public:
    // ============================================================================
    // ============================================================================

    virtual void addTerminalNode( const NodeId& n, const GUM_SCALAR& v ) = 0;

    virtual void eraseTerminalNode( const NodeId& n ) = 0;

    virtual void clearAllTerminalNodes() = 0;

    // ============================================================================
    // ============================================================================

    virtual bool existsTerminalNodeWithId( const NodeId& n ) const = 0;

    virtual bool existsTerminalNodeWithValue( const GUM_SCALAR& v ) const = 0;

    // ============================================================================
    // ============================================================================

    virtual const GUM_SCALAR& terminalNodeValue( const NodeId& n ) const = 0;

    virtual const NodeId& terminalNodeId( const GUM_SCALAR& v ) const = 0;

    // ============================================================================
    // ============================================================================

    virtual void beginValues() const = 0;

    virtual bool hasValue() const = 0;

    virtual void nextValue() const = 0;

    virtual const GUM_SCALAR& value() const = 0;

    virtual const NodeId& id() const = 0;

  };

}  // End of namespace gum

#endif /* GUM_MULTI_DIM_FUNCTION_GRAPH_INTERFACE_TERMINAL_NODE_POLICY_H */