Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members

STILEntityTable Class Reference

STILEntityTable Class Interface. More...

#include <stilentitytable.h>

List of all members.

Public Types

enum  STILEntityTableAllocType {
  NO_ALLOC,
  ALLOC
}

Public Member Functions

 STILEntityTable ()
 STILEntityTable (STILEntityTableAllocType)
 STILEntityTable (const STILEntityTable &)
 ~STILEntityTable ()
STILEntityTableoperator= (const STILEntityTable &)
void init (STILEntityTableAllocType table_type=NO_ALLOC)
void addTableEntity (const STILEntity *)
const STILEntitylocateTableEntity (const sstring &) const
LONG size () const
const STILEntityoperator[] (const LONG &) const


Detailed Description

STILEntityTable Class Interface.

This class represents the interface for a STIL entity table PUT SOME DESC HERE....


Member Enumeration Documentation

enum STILEntityTable::STILEntityTableAllocType
 

The type of table represented here. Table can own it's own storage or point at storage owned by another class.

Enumeration values:
NO_ALLOC  for now, == undefined_st
ALLOC  for now, == WFCS (PUT SOME DESC HERE)


Constructor & Destructor Documentation

STILEntityTable::STILEntityTable  ) 
 

Default Constructor for a STILEntityTable object.

Parameters:
 
Returns:

STILEntityTable::STILEntityTable STILEntityTableAllocType  table_type  ) 
 

Construct a STILEntityTable object, initializing it with the necessary initial symbols.

Parameters:
table_type Descriptor for the contents of the underlying table
Returns:

STILEntityTable::STILEntityTable const STILEntityTable st  ) 
 

Copy constructor for a STILEntityTable object.

Parameters:
st (const STILEntityTable&)
Returns:

STILEntityTable::~STILEntityTable  ) 
 

Destructor for a STILEntityTable object.

Parameters:
 
Returns:


Member Function Documentation

void STILEntityTable::addTableEntity const STILEntity pVal  ) 
 

Add a new symbol entry to the table which maps to a STILEntity.

Parameters:
sym_name Symbol name to be added p_val Ptr to named STILEntity
Returns:
(void)

void STILEntityTable::init STILEntityTableAllocType  table_type = NO_ALLOC  ) 
 

Initializer for a STILEntityTable object.

Parameters:
table_type Can be one of the folowing: ALLOC - this table will own the storage for the objects in this table (will delete/new when needed) NO_ALLOC - this table just points to entities whose storage is owned elsewhere.
Returns:
(void)

const STILEntity * STILEntityTable::locateTableEntity const sstring symbol_name  )  const
 

Locate an entity in the table.

Parameters:
symbol_name Symbol name
Returns:
(const Symbol *) Pointer to symbol entry found (NULL if not)

STILEntityTable & STILEntityTable::operator= const STILEntityTable st  ) 
 

Equals operator for a STILEntityTable object.

Parameters:
st STILEntityTable&
Returns:
(STILEntityTable&) The new STILEntityTable reference

const STILEntity * STILEntityTable::operator[] const LONG idx  )  const
 

Index into the table.

Parameters:
idx Table index
Returns:
(const Symbol *) Pointer to symbol entry found (NULL if not)

LONG STILEntityTable::size  )  const [inline]
 

Parameters:
 
Returns:


The documentation for this class was generated from the following files:
This page last updated on 6 Jul 2007

SourceForge.net Logo