C++ main module for gpm Package  1.0
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
CORE_Map< Key, Value > Class Template Reference

this class describes a map More...

#include <CORE_Map.h>

Inheritance diagram for CORE_Map< Key, Value >:
Inheritance graph
[legend]
Collaboration diagram for CORE_Map< Key, Value >:
Collaboration graph
[legend]

Public Member Functions

 CORE_Map ()
 build a map More...
 
 CORE_Map (const CORE_Map< Key, Value > &m)
 copy a map More...
 
virtual ~CORE_Map ()
 destroy a map More...
 
void getSharedPointer (boost::shared_ptr< CORE_Map< Key, Value > > &p)
 return the shared pointer corresponding to the class with casting More...
 
void getSharedPointer (boost::shared_ptr< const CORE_Map< Key, Value > > &p) const
 return the shared pointer corresponding to the class whith casting More...
 
const Value & operator[] (const Key &k) const
 get object corresponding to key More...
 
Value & operator[] (const Key &k)
 get object corresponding to key More...
 
tBoolean exists (const Key &k) const
 exists return true if the key exists in map More...
 
const Value * get (const Key &k) const
 get the value at key k More...
 
Value * get (const Key &k)
 get the value at key k More...
 
int size () const
 return the size of the array More...
 
int getSize () const
 return the size of the array More...
 
void values (CORE_Vector< Value > &vals) const
 return an array of values More...
 
void getValues (CORE_Vector< Value > &vals) const
 return an array of values More...
 
void getValues (CORE_Array< Value > &vals) const
 return an array of values More...
 
void getValues (vector< Value > &vals) const
 return an array of values More...
 
void keys (CORE_Vector< Key > &ks) const
 return an array of keys More...
 
void getKeys (vector< Key > &ks) const
 return a vector of keys More...
 
void getKeys (CORE_Vector< Key > &ks) const
 return a vector of keys More...
 
void getKeys (CORE_Array< Key > &ks) const
 return a vector of keys More...
 
template<class K2 , class V2 >
void copy (const CORE_Map< K2, V2 > &mapCpy)
 copy a map More...
 
void put (const Key &k, const Value &v)
 set the value at the index k More...
 
void add (const Value &v)
 set the value at the index k More...
 
tBoolean remove (const Key &k)
 remove the key More...
 
tBoolean removeValue (const Value &k)
 remove the value More...
 
void clear ()
 clear the map More...
 
void begin ()
 begin More...
 
tBoolean hasNext () const
 had next More...
 
void next (Key &k, Value *&v)
 had next More...
 
void merge (const CORE_Map< Key, Value > &m)
 merge the map More...
 
void getSharedPointer (SP::CORE_Object &p)
 get the shared pointer of this class into p More...
 
void getSharedPointer (SPC::CORE_Object &p) const
 get the shared pointer of this class into p More...
 
tString getClassName () const
 return the class name of the object More...
 
tString getIdentityString () const
 return the identity string of the object of the form className_at_address More...
 
tString getPointerAddress () const
 return the identity string of the object More...
 
template<class T >
tBoolean isInstanceOf () const
 return true if the object is an instance of T More...
 
virtual tString toString () const
 return the string representation of the object node More...
 
virtual void print ()
 print the class More...
 
virtual ostream & print (ostream &out) const
 print the class More...
 
virtual void print (const tString &message)
 print the class More...
 
virtual void print (const tInteger &str)
 print More...
 
virtual void print (const tRelativeInteger &str)
 print More...
 
virtual void print (const tReal &str)
 print More...
 
virtual void print (const int &str)
 print More...
 

Static Public Member Functions

static boost::shared_ptr
< CORE_Map< Key, Value > > 
New ()
 return a CORE_Array shared pointer More...
 
static tString getClassName (const tString &identityString)
 return the class name of the object using only the identity string More...
 
template<class T >
static tString getTypeName ()
 get type name More...
 
static tBoolean is64Architecture ()
 return true if the machine is a 64 bits machine More...
 
static tBoolean is32Architecture ()
 return true if the machine is a 32 bits machine More...
 
static tString pointer2String (const void *obj)
 return the string represantation of a pointer More...
 
static void setOutput (ostream &out)
 set output More...
 
static ostream & getOutput ()
 get output More...
 
static void printObjectsInMemory ()
 print object in memory More...
 
static ostream & print (ostream &out, const tString &message)
 print the class More...
 
static void outputPrint (const tString &message)
 

Static Public Attributes

static tBoolean mIsMemoryTesting =false
 indicator to store all classes created and deleted only for debuging version More...
 

Protected Member Functions

void setThis (SP::CORE_Object p)
 set this weak shared pointer called toDoAfterThis setting method More...
 
virtual void setType (tString type)
 set the type of the object More...
 
virtual void toDoAfterThisSetting ()
 method called after setThis() method this method can oly be called once. More...
 

Detailed Description

template<class Key, class Value>
class CORE_Map< Key, Value >

this class describes a map

Constructor & Destructor Documentation

template<class Key , class Value >
CORE_Map< Key, Value >::CORE_Map ( )

build a map

template<class Key , class Value >
CORE_Map< Key, Value >::CORE_Map ( const CORE_Map< Key, Value > &  m)
template<class Key , class Value >
CORE_Map< Key, Value >::~CORE_Map ( )
virtual

destroy a map

Member Function Documentation

template<class Key, class Value>
void CORE_Map< Key, Value >::add ( const Value &  v)
inline

set the value at the index k

template<class Key, class Value>
void CORE_Map< Key, Value >::begin ( )
inline

begin

template<class Key, class Value>
void CORE_Map< Key, Value >::clear ( )
inline

clear the map

template<class Key , class Value >
template<class K2 , class V2 >
void CORE_Map< Key, Value >::copy ( const CORE_Map< K2, V2 > &  mapCpy)

copy a map

References CORE_Map< Key, Value >::get(), and CORE_Map< Key, Value >::getKeys().

Here is the call graph for this function:

template<class Key , class Value >
tBoolean CORE_Map< Key, Value >::exists ( const Key &  k) const

exists return true if the key exists in map

template<class Key , class Value >
const Value * CORE_Map< Key, Value >::get ( const Key &  k) const

get the value at key k

Returns
null if no corresponding key

References null.

Referenced by CORE_Map< Key, Value >::copy(), CORE_Map< Key, Value >::CORE_Map(), and CORE_Map< Key, Value >::merge().

Here is the caller graph for this function:

template<class Key , class Value >
Value * CORE_Map< Key, Value >::get ( const Key &  k)

get the value at key k

Returns
null if no corresponding key

References null.

static tString CORE_Object::getClassName ( const tString identityString)
inlinestaticinherited

return the class name of the object using only the identity string

Referenced by CORE_Object::printObjectsInMemory().

Here is the caller graph for this function:

tString CORE_Object::getClassName ( ) const
inherited

return the class name of the object

Returns
the class name of the object

References tString.

Referenced by CORE_Object::getIdentityString().

Here is the caller graph for this function:

tString CORE_Object::getIdentityString ( ) const
inlineinherited

return the identity string of the object of the form className_at_address

Returns
the identity string of the object

References CORE_Object::getClassName(), CORE_Object::pointer2String(), and tString.

Referenced by CORE_Object::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Key , class Value >
void CORE_Map< Key, Value >::getKeys ( vector< Key > &  ks) const

return a vector of keys

Referenced by CORE_Map< Key, Value >::copy(), CORE_Map< Key, Value >::CORE_Map(), and CORE_Map< Key, Value >::merge().

Here is the caller graph for this function:

template<class Key , class Value >
void CORE_Map< Key, Value >::getKeys ( CORE_Vector< Key > &  ks) const

return a vector of keys

References CORE_Vector< T >::add(), and CORE_Vector< T >::clear().

Here is the call graph for this function:

template<class Key , class Value >
void CORE_Map< Key, Value >::getKeys ( CORE_Array< Key > &  ks) const

return a vector of keys

References CORE_Array< T >::add(), and CORE_Array< T >::clear().

Here is the call graph for this function:

static ostream& CORE_Object::getOutput ( )
inlinestaticinherited

get output

tString CORE_Object::getPointerAddress ( ) const
inlineinherited

return the identity string of the object

Returns
the identity string of the object

References CORE_Object::pointer2String().

Here is the call graph for this function:

template<class Key, class Value>
void CORE_Map< Key, Value >::getSharedPointer ( boost::shared_ptr< CORE_Map< Key, Value > > &  p)
inline

return the shared pointer corresponding to the class with casting

References CORE_Object::getSharedPointer().

Here is the call graph for this function:

void CORE_Object::getSharedPointer ( SP::CORE_Object &  p)
inlineinherited
template<class Key, class Value>
void CORE_Map< Key, Value >::getSharedPointer ( boost::shared_ptr< const CORE_Map< Key, Value > > &  p) const
inline

return the shared pointer corresponding to the class whith casting

References CORE_Object::getSharedPointer().

Here is the call graph for this function:

void CORE_Object::getSharedPointer ( SPC::CORE_Object &  p) const
inlineinherited

get the shared pointer of this class into p

template<class Key, class Value>
int CORE_Map< Key, Value >::getSize ( ) const
inline

return the size of the array

template<class T >
static tString CORE_Object::getTypeName ( )
inlinestaticinherited

get type name

References tString.

template<class Key , class Value >
void CORE_Map< Key, Value >::getValues ( CORE_Vector< Value > &  vals) const

return an array of values

References CORE_Vector< T >::clear(), CORE_Vector< T >::set(), CORE_Vector< T >::setSize(), and tInteger.

Here is the call graph for this function:

template<class Key , class Value >
void CORE_Map< Key, Value >::getValues ( CORE_Array< Value > &  vals) const

return an array of values

References CORE_Array< T >::clear(), CORE_Array< T >::set(), CORE_Array< T >::setSize(), and tInteger.

Here is the call graph for this function:

template<class Key , class Value >
void CORE_Map< Key, Value >::getValues ( vector< Value > &  vals) const

return an array of values

References tInteger.

template<class Key, class Value>
tBoolean CORE_Map< Key, Value >::hasNext ( ) const
inline

had next

static tBoolean CORE_Object::is32Architecture ( )
inlinestaticinherited

return true if the machine is a 32 bits machine

References CORE_Object::is64Architecture().

Here is the call graph for this function:

tBoolean CORE_Object::is64Architecture ( )
staticinherited

return true if the machine is a 64 bits machine

Referenced by CORE_Object::is32Architecture().

Here is the caller graph for this function:

template<class T >
tBoolean CORE_Object::isInstanceOf ( ) const
inlineinherited

return true if the object is an instance of T

References null.

Referenced by MATH_BinaryOperator::insertInTree(), MATH_UnaryOperator::insertInTree(), and MATH_EndBlock::insertInTree().

Here is the caller graph for this function:

template<class Key, class Value>
void CORE_Map< Key, Value >::keys ( CORE_Vector< Key > &  ks) const
inline

return an array of keys

Referenced by CORE_Map< Key, Value >::CORE_Map().

Here is the caller graph for this function:

template<class Key , class Value >
void CORE_Map< Key, Value >::merge ( const CORE_Map< Key, Value > &  m)

merge the map

References CORE_Map< Key, Value >::get(), and CORE_Map< Key, Value >::getKeys().

Here is the call graph for this function:

template<class Key, class Value>
static boost::shared_ptr<CORE_Map<Key,Value> > CORE_Map< Key, Value >::New ( )
inlinestatic

return a CORE_Array shared pointer

template<class Key, class Value>
void CORE_Map< Key, Value >::next ( Key &  k,
Value *&  v 
)
inline

had next

template<class Key, class Value>
const Value& CORE_Map< Key, Value >::operator[] ( const Key &  k) const
inline

get object corresponding to key

References ASSERT_IN.

template<class Key, class Value>
Value& CORE_Map< Key, Value >::operator[] ( const Key &  k)
inline

get object corresponding to key

References ASSERT_IN.

void CORE_Object::outputPrint ( const tString message)
staticinherited

print on output

References null, and CORE_Object::print().

Referenced by CORE_Exception::CORE_Exception().

Here is the call graph for this function:

Here is the caller graph for this function:

tString CORE_Object::pointer2String ( const void *  obj)
staticinherited

return the string represantation of a pointer

References tString.

Referenced by CORE_Object::CORE_Object(), CORE_Object::getIdentityString(), CORE_Object::getPointerAddress(), and CORE_Object::~CORE_Object().

Here is the caller graph for this function:

virtual void CORE_Object::print ( )
inlinevirtualinherited

print the class

References CORE_Object::toString().

Referenced by CORE_Object::outputPrint(), CORE_Out::print(), CORE_Object::print(), CORE_Out::printInt(), CORE_Out::println(), CORE_Out::printReal(), CORE_Out::printString(), and CORE_Out::setAction().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual ostream& CORE_Object::print ( ostream &  out) const
inlinevirtualinherited

print the class

References CORE_Object::print(), and CORE_Object::toString().

Here is the call graph for this function:

void CORE_Object::print ( const tString message)
virtualinherited

print the class

Reimplemented in CORE_Out.

References null, and CORE_Object::print().

Here is the call graph for this function:

void CORE_Object::print ( const tInteger str)
virtualinherited

print

References null.

void CORE_Object::print ( const tRelativeInteger str)
virtualinherited

print

References null.

void CORE_Object::print ( const tReal str)
virtualinherited

print

References null.

void CORE_Object::print ( const int &  str)
virtualinherited

print

References null.

static ostream& CORE_Object::print ( ostream &  out,
const tString message 
)
inlinestaticinherited

print the class

void CORE_Object::printObjectsInMemory ( )
staticinherited

print object in memory

References CORE_Object::getClassName(), CORE_Object::getSharedPointer(), and CORE_Object::mIsMemoryTesting.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Key, class Value>
void CORE_Map< Key, Value >::put ( const Key &  k,
const Value &  v 
)
inline

set the value at the index k

Referenced by CORE_Map< Key, Value >::CORE_Map().

Here is the caller graph for this function:

template<class Key , class Value >
tBoolean CORE_Map< Key, Value >::remove ( const Key &  k)

remove the key

Returns
true if the removing success and false if the element does not exist in the map at key k
template<class Key , class Value >
tBoolean CORE_Map< Key, Value >::removeValue ( const Value &  k)

remove the value

Returns
true if the removing success and false if the element does not exist in the map

References tBoolean.

static void CORE_Object::setOutput ( ostream &  out)
inlinestaticinherited

set output

void CORE_Object::setThis ( SP::CORE_Object  p)
inlineprotectedinherited

set this weak shared pointer called toDoAfterThis setting method

References CORE_Object::toDoAfterThisSetting().

Here is the call graph for this function:

virtual void CORE_Object::setType ( tString  type)
inlineprotectedvirtualinherited
template<class Key, class Value>
int CORE_Map< Key, Value >::size ( ) const
inline

return the size of the array

virtual void CORE_Object::toDoAfterThisSetting ( )
inlineprotectedvirtualinherited
tString CORE_Object::toString ( ) const
virtualinherited
template<class Key, class Value>
void CORE_Map< Key, Value >::values ( CORE_Vector< Value > &  vals) const
inline

return an array of values

Member Data Documentation

tBoolean CORE_Object::mIsMemoryTesting =false
staticinherited

indicator to store all classes created and deleted only for debuging version

Referenced by CORE_Object::CORE_Object(), main(), CORE_Object::printObjectsInMemory(), and CORE_Object::~CORE_Object().


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