clipsmm - C++ CLIPS Interface Library

clipsmm logo
Public Types | Public Member Functions | Static Public Member Functions | List of all members
CLIPS::Fact Class Reference

#include <fact.h>

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

Public Types

typedef CLIPSPointer< Factpointer
 

Public Member Functions

 Fact (Environment &environment, void *cobj=NULL)
 
 ~Fact ()
 
bool assign_slot_defaults ()
 Assigns default values to a fact. More...
 
Template::pointer get_template ()
 Returns the template associated with a fact. More...
 
bool exists () const
 Indicates whether a fact is still in the fact list or has been retracted. More...
 
long int index () const
 Returns the fact index of a fact. More...
 
std::vector< std::string > slot_names ()
 Returns the slot names associated with this fact. More...
 
Values slot_value (const std::string &slot_name)
 Return the values contained within a slot. More...
 
Fact::pointer next ()
 Returns the next fact in the fact list. More...
 
bool set_slot (const std::string &slot_name, const Values &values)
 Sets the named slot to a specific value or values. More...
 
bool set_slot (const std::string &slot_name, const Value &value)
 Sets the named slot to a specific value or values. More...
 
bool retract ()
 Retracts a fact from the fact list. More...
 
bool operator== (const Fact &other) const
 
bool operator== (const Fact::pointer &other) const
 
unsigned int refcount () const
 
- 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. More...
 

Static Public Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from CLIPS::EnvironmentObject
Environmentm_environment
 

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

Constructor & Destructor Documentation

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

Member Function Documentation

bool CLIPS::Fact::assign_slot_defaults ( )

Assigns default values to a fact.

Returns
true if the default values were successfully set, false otherwise

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

Fact::pointer CLIPS::Fact::create ( Environment environment,
void *  cobj = NULL 
)
static
Fact::pointer CLIPS::Fact::create ( Environment environment,
Template::pointer  temp 
)
static

References CLIPS::Object::cobj(), and Fact().

bool CLIPS::Fact::exists ( ) const

Indicates whether a fact is still in the fact list or has been retracted.

Returns
true if the fact is still in the fact list, false otherwise

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

Referenced by next().

Template::pointer CLIPS::Fact::get_template ( )
long int CLIPS::Fact::index ( ) const

Returns the fact index of a fact.

Returns
the index of the fact or -1 if this fact object is uninitialized

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

Referenced by operator==().

Fact::pointer CLIPS::Fact::next ( )

Returns the next fact in the fact list.

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

bool CLIPS::Fact::operator== ( const Fact other) const

References index().

bool CLIPS::Fact::operator== ( const Fact::pointer other) const

References index().

unsigned int CLIPS::Fact::refcount ( ) const

References CLIPS::Object::m_cobj.

bool CLIPS::Fact::retract ( )

Retracts a fact from the fact list.

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

bool CLIPS::Fact::set_slot ( const std::string &  slot_name,
const Values values 
)

Sets the named slot to a specific value or values.

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

bool CLIPS::Fact::set_slot ( const std::string &  slot_name,
const Value value 
)

Sets the named slot to a specific value or values.

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

std::vector< std::string > CLIPS::Fact::slot_names ( )
Values CLIPS::Fact::slot_value ( const std::string &  slot_name)

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

Generated on Thu Oct 24 2013 06:16:16 for clipsmm by doxygen 1.8.3.1