template.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2006 by Rick L. Vinyard, Jr.                            *
 *   rvinyard@cs.nmsu.edu                                                  *
 *                                                                         *
 *   This file is part of the clipsmm library.                             *
 *                                                                         *
 *   The clipsmm library is free software; you can redistribute it and/or  *
 *   modify it under the terms of the GNU General Public License           *
 *   version 3 as published by the Free Software Foundation.               *
 *                                                                         *
 *   The clipsmm library 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 software. If not see <http://www.gnu.org/licenses/>.  *
 ***************************************************************************/
#ifndef CLIPSTEMPLATE_H
#define CLIPSTEMPLATE_H

#include <vector>

#include <clipsmm/environmentobject.h>
#include <clipsmm/value.h>

#undef NO_DEFAULT
#undef STATIC_DEFAULT
#undef DYNAMIC_DEFAULT

namespace CLIPS {

typedef enum DefaultType {
  NO_DEFAULT=0,
  STATIC_DEFAULT=1,
  DYNAMIC_DEFAULT=2,
} DefaultType;

class Template: public EnvironmentObject {
public:
  typedef CLIPSPointer<Template> pointer;

  Template( Environment& environment, void* cobj=NULL );

  static Template::pointer create( Environment& environment, void* cobj=NULL );

    ~Template();

    std::string name();

    std::string module_name();

    std::string formatted();

                Values slot_allowed_values( const std::string& slot_name );

    Values slot_cardinality( const std::string& slot_name );

    DefaultType slot_default_type( const std::string& slot_name );

    Values slot_default_value( const std::string& slot_name );

    Values slot_range( const std::string& slot_name );

    bool slot_exists( const std::string& slot_name );

    bool is_multifield_slot( const std::string& slot_name );

    bool is_single_field_slot( const std::string& slot_name );

    std::vector<std::string> slot_names();

    bool is_watched();

    Template::pointer next();

    bool is_deletable();

    void set_watch( unsigned state );

    bool retract();

  protected:

};

}

#endif