DACLIPS::Template Class Reference

#include <template.h>

Inheritance diagram for DACLIPS::Template:

Inheritance graph
[legend]
Collaboration diagram for DACLIPS::Template:

Collaboration graph
[legend]

List of all members.

Public Types

typedef CLIPSPointer< Templatepointer
typedef CLIPSPointer< Templatepointer

Public Member Functions

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

Static Public Member Functions

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


Detailed Description

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

Definition at line 42 of file template.h.


Member Typedef Documentation

typedef CLIPSPointer<Template> DACLIPS::Template::pointer

Reimplemented from DACLIPS::Object.

Definition at line 44 of file template.h.

typedef CLIPSPointer<Template> DACLIPS::Template::pointer

Reimplemented from DACLIPS::Object.

Definition at line 44 of file template.h.


Constructor & Destructor Documentation

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

Definition at line 29 of file template.cpp.

DACLIPS::Template::~Template (  ) 

Definition at line 36 of file template.cpp.

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

DACLIPS::Template::~Template (  ) 


Member Function Documentation

Template::pointer DACLIPS::Template::create ( Environment environment,
void *  cobj = NULL 
) [static]

Definition at line 32 of file template.cpp.

std::string DACLIPS::Template::name (  ) 

The name of this template

Definition at line 38 of file template.cpp.

std::string DACLIPS::Template::module_name (  ) 

The name of the module this template is in

Definition at line 45 of file template.cpp.

std::string DACLIPS::Template::formatted (  ) 

Definition at line 52 of file template.cpp.

Values DACLIPS::Template::slot_allowed_values ( const std::string &  slot_name  ) 

Returns the allowed values for a given slot

Definition at line 59 of file template.cpp.

Values DACLIPS::Template::slot_cardinality ( const std::string &  slot_name  ) 

Returns the cardinality information for a slot

Definition at line 71 of file template.cpp.

DefaultType DACLIPS::Template::slot_default_type ( const std::string &  slot_name  ) 

Determines whether a slot has a default value

Definition at line 120 of file template.cpp.

Values DACLIPS::Template::slot_default_value ( const std::string &  slot_name  ) 

Returns the default value for a given slot

Definition at line 126 of file template.cpp.

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

Returns the range information for a slot

Definition at line 137 of file template.cpp.

bool DACLIPS::Template::slot_exists ( const std::string &  slot_name  ) 

Determines whether a slot exists in the template

Definition at line 83 of file template.cpp.

bool DACLIPS::Template::is_multifield_slot ( const std::string &  slot_name  ) 

Determines whether a slot is a multifield slot

Definition at line 92 of file template.cpp.

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

Determines whether a slot is a single field slot

Definition at line 101 of file template.cpp.

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

Returns the slot names associated with this template

Definition at line 110 of file template.cpp.

bool DACLIPS::Template::is_watched (  ) 

True is this template is being watched

Definition at line 148 of file template.cpp.

Template::pointer DACLIPS::Template::next (  ) 

Definition at line 154 of file template.cpp.

bool DACLIPS::Template::is_deletable (  ) 

Definition at line 165 of file template.cpp.

void DACLIPS::Template::set_watch ( unsigned  state  ) 

Definition at line 171 of file template.cpp.

bool DACLIPS::Template::retract (  ) 

Definition at line 176 of file template.cpp.

static Template::pointer DACLIPS::Template::create ( Environment environment,
void *  cobj = NULL 
) [static]

std::string DACLIPS::Template::name (  ) 

The name of this template

std::string DACLIPS::Template::module_name (  ) 

The name of the module this template is in

std::string DACLIPS::Template::formatted (  ) 

Values DACLIPS::Template::slot_allowed_values ( const std::string &  slot_name  ) 

Returns the allowed values for a given slot

Values DACLIPS::Template::slot_cardinality ( const std::string &  slot_name  ) 

Returns the cardinality information for a slot

DefaultType DACLIPS::Template::slot_default_type ( const std::string &  slot_name  ) 

Determines whether a slot has a default value

Values DACLIPS::Template::slot_default_value ( const std::string &  slot_name  ) 

Returns the default value for a given slot

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

Returns the range information for a slot

bool DACLIPS::Template::slot_exists ( const std::string &  slot_name  ) 

Determines whether a slot exists in the template

bool DACLIPS::Template::is_multifield_slot ( const std::string &  slot_name  ) 

Determines whether a slot is a multifield slot

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

Determines whether a slot is a single field slot

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

Returns the slot names associated with this template

bool DACLIPS::Template::is_watched (  ) 

True is this template is being watched

Template::pointer DACLIPS::Template::next (  ) 

bool DACLIPS::Template::is_deletable (  ) 

void DACLIPS::Template::set_watch ( unsigned  state  ) 

bool DACLIPS::Template::retract (  ) 


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

Generated on Mon Jan 10 22:33:44 2011 by  doxygen 1.5.6