clipsmm - C++ CLIPS Interface Library

clipsmm logo
Public Types | Public Member Functions | Static Public Member Functions
CLIPS::Template Class Reference

#include <template.h>

Inheritance diagram for CLIPS::Template:
Inheritance graph
[legend]

List of all members.

Public Types

typedef CLIPSPointer< Templatepointer

Public Member Functions

 Template (Environment &environment, void *cobj=NULL)
 ~Template ()
std::string name ()
 The name of this template.
std::string module_name ()
 The name of the module this template is in.
std::string formatted ()
Values slot_allowed_values (const std::string &slot_name)
 Returns the allowed values for a given slot.
Values slot_cardinality (const std::string &slot_name)
 Returns the cardinality information for a slot.
DefaultType slot_default_type (const std::string &slot_name)
 Determines whether a slot has a default value.
Values slot_default_value (const std::string &slot_name)
 Returns the default value for a given slot.
Values slot_range (const std::string &slot_name)
 Returns the range information for a slot.
bool slot_exists (const std::string &slot_name)
 Determines whether a slot exists in the template.
bool is_multifield_slot (const std::string &slot_name)
 Determines whether a slot is a multifield slot.
bool is_single_field_slot (const std::string &slot_name)
 Determines whether a slot is a single field slot.
std::vector< std::string > slot_names ()
 Returns the slot names associated with this template.
bool is_watched ()
 True is this template is being watched.
Template::pointer next ()
bool is_deletable ()
void set_watch (unsigned state)
bool retract ()
- Public Member Functions inherited from CLIPS::EnvironmentObject
 EnvironmentObject (Environment &environment, void *cobj=NULL)
 ~EnvironmentObject ()
Environmentenvironment () const
- Public Member Functions inherited from CLIPS::Object
 Object (void *cobj=NULL)
 ~Object ()
void * cobj () const
 Returns a pointer to the underlying CLIPS C object.

Static Public Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from CLIPS::EnvironmentObject
Environmentm_environment
- Protected Attributes inherited from CLIPS::Object
void * m_cobj
 The underlying CLIPS C object.

Detailed Description

Author:
Rick L. Vinyard, Jr. rviny.nosp@m.ard@.nosp@m.cs.nm.nosp@m.su.e.nosp@m.du

Member Typedef Documentation

Reimplemented from CLIPS::Object.


Constructor & Destructor Documentation

CLIPS::Template::Template ( Environment environment,
void *  cobj = NULL 
)

Referenced by create().

CLIPS::Template::~Template ( )

Member Function Documentation

Template::pointer CLIPS::Template::create ( Environment environment,
void *  cobj = NULL 
)
static
std::string CLIPS::Template::formatted ( )
bool CLIPS::Template::is_deletable ( )
bool CLIPS::Template::is_multifield_slot ( const std::string &  slot_name)

Determines whether a slot is a multifield slot.

References CLIPS::Object::cobj(), CLIPS::Object::m_cobj, and CLIPS::EnvironmentObject::m_environment.

bool CLIPS::Template::is_single_field_slot ( const std::string &  slot_name)

Determines whether a slot is a single field slot.

References CLIPS::Object::cobj(), CLIPS::Object::m_cobj, and CLIPS::EnvironmentObject::m_environment.

bool CLIPS::Template::is_watched ( )

True is this template is being watched.

References CLIPS::Object::cobj(), CLIPS::Object::m_cobj, and CLIPS::EnvironmentObject::m_environment.

std::string CLIPS::Template::module_name ( )

The name of the module this template is in.

References CLIPS::Object::cobj(), CLIPS::Object::m_cobj, and CLIPS::EnvironmentObject::m_environment.

std::string CLIPS::Template::name ( )
Template::pointer CLIPS::Template::next ( )
bool CLIPS::Template::retract ( )
void CLIPS::Template::set_watch ( unsigned  state)
Values CLIPS::Template::slot_allowed_values ( const std::string &  slot_name)
Values CLIPS::Template::slot_cardinality ( const std::string &  slot_name)
DefaultType CLIPS::Template::slot_default_type ( const std::string &  slot_name)

Determines whether a slot has a default value.

References CLIPS::Object::cobj(), CLIPS::Object::m_cobj, CLIPS::EnvironmentObject::m_environment, and CLIPS::NO_DEFAULT.

Values CLIPS::Template::slot_default_value ( const std::string &  slot_name)
bool CLIPS::Template::slot_exists ( const std::string &  slot_name)

Determines whether a slot exists in the template.

References CLIPS::Object::cobj(), CLIPS::Object::m_cobj, and CLIPS::EnvironmentObject::m_environment.

std::vector< std::string > CLIPS::Template::slot_names ( )

Returns the slot names associated with this template.

References CLIPS::Object::cobj(), CLIPS::data_object_to_strings(), CLIPS::Object::m_cobj, and CLIPS::EnvironmentObject::m_environment.

Values CLIPS::Template::slot_range ( const std::string &  slot_name)

The documentation for this class was generated from the following files:

Generated on Sat Apr 13 2013 10:04:52 for clipsmm by doxygen 1.8.1.1