CLIPS::Fact Class Reference

#include <fact.h>

Inheritance diagram for CLIPS::Fact:

Public Types
typedef CLIPSPointer< Fact >	pointer
Public Types inherited from CLIPS::Object
typedef CLIPSPointer< Object >	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 () const
	Indicates whether a fact is still in the fact list or has been retracted.
long int	index () const
	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.
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 ()
Environment &	environment () 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 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
Environment &	m_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

pointer

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

Constructor & Destructor Documentation

Fact()

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

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

Referenced by create(), and create().

~Fact()

CLIPS::Fact::~Fact

(

)

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

Member Function Documentation

assign_slot_defaults()

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.

create() [1/2]

Fact::pointer CLIPS::Fact::create ( Environment & environment, Template::pointer temp )

static

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

create() [2/2]

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

static

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

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

exists()

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

get_template()

Template::pointer CLIPS::Fact::get_template

(

)

Returns the template associated with a fact.

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

index()

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==(), and operator==().

next()

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.

operator==() [1/2]

bool CLIPS::Fact::operator==

(

const Fact &

other

)

const

References index().

operator==() [2/2]

bool CLIPS::Fact::operator==

(

const Fact::pointer &

other

)

const

References index().

refcount()

unsigned int CLIPS::Fact::refcount

(

)

const

References CLIPS::Object::m_cobj.

retract()

bool CLIPS::Fact::retract

(

)

Retracts a fact from the fact list.

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

set_slot() [1/2]

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

set_slot() [2/2]

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

slot_names()

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.

slot_value()

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