CLIPS::Fact Class Reference

#include <fact.h>

Inheritance diagram for CLIPS::Fact:

[legend]

List of all members.

Public Types
typedef CLIPSPointer< Fact >	pointer
Public Member Functions
	Fact (Environment &environment, void *cobj=NULL)
	~Fact ()
bool	assign_slot_defaults ()
	Assigns default values to a fact.
Template::pointer	get_template ()
	Returns the template associated with a fact.
bool	exists ()
	Indicates whether a fact is still in the fact list or has been retracted.
long int	index ()
	Returns the fact index of a fact.
std::vector< std::string >	slot_names ()
	Returns the slot names associated with this fact.
Values	slot_value (const std::string &slot_name)
	Return the values contained within a slot.
Fact::pointer	next ()
	Returns the next fact in the fact list.
bool	set_slot (const std::string &slot_name, const Values &values)
	Sets the named slot to a specific value or values.
bool	set_slot (const std::string &slot_name, const Value &value)
	Sets the named slot to a specific value or values.
bool	retract ()
	Retracts a fact from the fact list.
Static Public Member Functions
static Fact::pointer	create (Environment &environment, void *cobj=NULL)

---

Detailed Description

Author:

Rick L. Vinyard, Jr. <rvinyard@cs.nmsu.edu>

---

Member Typedef Documentation

typedef CLIPSPointer<Fact> CLIPS::Fact::pointer

Reimplemented from CLIPS::Object.

---

Constructor & Destructor Documentation

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

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

Referenced by create().

CLIPS::Fact::~Fact

(

)

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

---

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]

References Fact().

Referenced by CLIPS::Environment::assert_fact(), get_template(), and next().

bool CLIPS::Fact::exists

(

)

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

(

)

Returns the template associated with a fact.

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

long int CLIPS::Fact::index

(

)

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.

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::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 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().

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().

std::vector< std::string > CLIPS::Fact::slot_names

(

)

Returns the slot names associated with this fact.

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

Values CLIPS::Fact::slot_value

(

const std::string &

slot_name

)

Return the values contained within a slot.

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

---

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

• fact.h
• fact.cpp