This class describes a map: shared pointer of Key -> shared pointer of Value. More...

#include <CORE_SharedPointersKVMap.h>

Inheritance diagram for CORE_SharedPointersKVMap< Key, Value >:

Collaboration diagram for CORE_SharedPointersKVMap< Key, Value >:

Public Member Functions
	CORE_SharedPointersKVMap ()

template<class K , class Q >
	CORE_SharedPointersKVMap (const CORE_SharedPointersKVMap< K, Q > &m)
	copy a map More...

virtual	~CORE_SharedPointersKVMap ()
	destroy a map More...

const boost::shared_ptr< Value > &	operator[] (const boost::shared_ptr< Key > &k) const
	get object corresponding to key More...

boost::shared_ptr< Value > &	operator[] (const boost::shared_ptr< Key > &k)
	get object corresponding to key More...

tBoolean	exists (const boost::shared_ptr< Key > &k) const
	exists return true if the key exists in map More...

const Value *	get (const boost::shared_ptr< Key > &k) const
	get the value at key k More...

Value *	get (const boost::shared_ptr< 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_SharedPointersList< Value > &vals) const
	return an array of values 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 (vector< Value * > &vals) const
	return an array of values More...

void	getValues (CORE_SharedPointersList< Value > &vals) const
	return an array of values More...

void	keys (CORE_SharedPointersList< Key > &ks) const
	return an array of keys More...

void	getKeys (CORE_SharedPointersList< 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	begin ()
	begin More...

tBoolean	hasNext () const
	had next More...

void	next (Key &k, Value &v)
	had next More...

template<class K , class V >
void	copy (const CORE_SharedPointersKVMap< K, V > &mapCpy)
	copy a map More...

void	put (const boost::shared_ptr< const Key > &k, const boost::shared_ptr< const Value > &v)
	set the value at the index k More...

void	put (const boost::shared_ptr< Key > &k, const boost::shared_ptr< Value > &v)
	set the value at the index k More...

tBoolean	remove (const boost::shared_ptr< Key > &k)
	remove the key More...

tBoolean	removeValue (const Value *k)
	remove the value More...

tBoolean	removeValue (const Value &k)
	remove the value More...

tBoolean	removeValue (boost::shared_ptr< Value > &k)
	remove the value More...

void	clear ()
	clear the map More...

template<class K , class V >
void	merge (const CORE_SharedPointersKVMap< K, V > &m)
	merge the map More...

virtual tString	toString () const
	return the string representation of the object node More...

template<class K , class V >
	CORE_SharedPointersKVMap (const CORE_SharedPointersKVMap< K, V > &m)
	copy constructor of double shared pointers 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 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 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_SharedPointersKVMap< Key, Value >

This class describes a map: shared pointer of Key -> shared pointer of Value.

Author: St�phane Despr�aux

Version: 1.0

Constructor & Destructor Documentation

template<class K , class V >

CORE_SharedPointersKVMap< K, V >::CORE_SharedPointersKVMap ( )

template<class Key, class Value>

template<class K , class Q >

CORE_SharedPointersKVMap< Key, Value >::CORE_SharedPointersKVMap ( const CORE_SharedPointersKVMap< K, Q > & m )

copy a map

template<class Key , class Value >

CORE_SharedPointersKVMap< Key, Value >::~CORE_SharedPointersKVMap ( )

virtual

destroy a map

template<class Key, class Value>

template<class K , class V >

CORE_SharedPointersKVMap< Key, Value >::CORE_SharedPointersKVMap ( const CORE_SharedPointersKVMap< K, V > & m )

copy constructor of double shared pointers Map

Parameters

m	map to copy

References CORE_SharedPointersKVMap< Key, Value >::copy().

Here is the call graph for this function:

Member Function Documentation

template<class Key, class Value>

void CORE_SharedPointersKVMap< Key, Value >::begin ( )

inline

begin

template<class Key, class Value>

void CORE_SharedPointersKVMap< Key, Value >::clear ( )

inline

clear the map

template<class Key , class Value >

template<class K , class V >

void CORE_SharedPointersKVMap< Key, Value >::copy ( const CORE_SharedPointersKVMap< K, V > & mapCpy )

copy a map

References CORE_SharedPointersKVMap< Key, Value >::getKeys().

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

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Key , class Value >

tBoolean CORE_SharedPointersKVMap< Key, Value >::exists ( const boost::shared_ptr< Key > & k ) const

exists return true if the key exists in map

Referenced by CORE_SharedPointersKVMap< Key, Value >::operator[]().

Here is the caller graph for this function:

template<class Key , class Value >

const Value * CORE_SharedPointersKVMap< Key, Value >::get ( const boost::shared_ptr< Key > & k ) const

get the value at key k

Returns: null if no corresponding key

References null.

template<class Key , class Value >

Value * CORE_SharedPointersKVMap< Key, Value >::get ( const boost::shared_ptr< 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_SharedPointersKVMap< Key, Value >::getKeys ( CORE_SharedPointersList< Key > & ks ) const

return an array of keys

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Key , class Value >

void CORE_SharedPointersKVMap< Key, Value >::getKeys ( vector< Key * > & ks ) const

return a vector of keys

template<class Key , class Value >

void CORE_SharedPointersKVMap< Key, Value >::getKeys ( CORE_Vector< Key * > & ks ) const

return a vector of keys

References CORE_Vector< T >::setSize().

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:

void CORE_Object::getSharedPointer ( SP::CORE_Object & p )

inlineinherited

get the shared pointer of this class into p

Referenced by MATH_ParentExpression::addArgument(), GPMG_EnvironmentPanel::componentClicked(), GPM_GraphElement::copy(), CORE_Map< Key, Value >::getSharedPointer(), CORE_Array< T >::getSharedPointer(), CORE_Vector< T >::getSharedPointer(), CORE_Matrix< T >::getSharedPointer(), CORE_Object::printObjectsInMemory(), MATH_ParentExpression::setArgument(), GPMG_EnvironmentPanel::setEnvironment(), GPM_GraphElement::setGraph(), GPMG_GraphElementWindow::setGraphElement(), GPMG_ShowGraphDrawPanel::showGraph(), and GPMG_RuleGraphDrawPanel::showRule().

Here is the caller 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_SharedPointersKVMap< 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_SharedPointersKVMap< Key, Value >::getValues ( CORE_Vector< Value * > & vals ) const

return an array of values

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

Referenced by CORE_SharedPointersKVMap< Key, Value >::values().

Here is the call graph for this function:

Here is the caller graph for this function:

template<class Key , class Value >

void CORE_SharedPointersKVMap< Key, Value >::getValues ( vector< Value * > & vals ) const

return an array of values

References tInteger.

template<class Key , class Value >

void CORE_SharedPointersKVMap< Key, Value >::getValues ( CORE_SharedPointersList< Value > & vals ) const

return an array of values

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

Here is the call graph for this function:

template<class Key, class Value>

tBoolean CORE_SharedPointersKVMap< 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_SharedPointersKVMap< Key, Value >::keys ( CORE_SharedPointersList< Key > & ks ) const

inline

return an array of keys

References CORE_SharedPointersKVMap< Key, Value >::getKeys().

Here is the call graph for this function:

template<class Key , class Value >

template<class K , class V >

void CORE_SharedPointersKVMap< Key, Value >::merge ( const CORE_SharedPointersKVMap< K, V > & m )

merge the map

References CORE_SharedPointersKVMap< Key, Value >::getKeys(), and CORE_SharedPointersList< T >::size().

Here is the call graph for this function:

template<class Key, class Value>

void CORE_SharedPointersKVMap< Key, Value >::next	(	Key *&	k,
		Value *&	v
	)

inline

had next

template<class Key, class Value>

const boost::shared_ptr<Value>& CORE_SharedPointersKVMap< Key, Value >::operator[] ( const boost::shared_ptr< Key > & k ) const

inline

get object corresponding to key

References ASSERT_IN, and CORE_SharedPointersKVMap< Key, Value >::exists().

Here is the call graph for this function:

template<class Key, class Value>

boost::shared_ptr<Value>& CORE_SharedPointersKVMap< Key, Value >::operator[] ( const boost::shared_ptr< Key > & k )

inline

get object corresponding to key

References ASSERT_IN, and CORE_SharedPointersKVMap< Key, Value >::exists().

Here is the call graph for this function:

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_SharedPointersKVMap< Key, Value >::put	(	const boost::shared_ptr< const Key > &	k,
		const boost::shared_ptr< const Value > &	v
	)

inline

set the value at the index k

template<class Key, class Value>

void CORE_SharedPointersKVMap< Key, Value >::put	(	const boost::shared_ptr< Key > &	k,
		const boost::shared_ptr< Value > &	v
	)

inline

set the value at the index k

template<class Key , class Value >

tBoolean CORE_SharedPointersKVMap< Key, Value >::remove ( const boost::shared_ptr< 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_SharedPointersKVMap< 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 CORE_SharedPointersList< T >::size(), and tBoolean.

Here is the call graph for this function:

template<class Key , class Value >

tBoolean CORE_SharedPointersKVMap< 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 CORE_SharedPointersList< T >::size(), and tBoolean.

Here is the call graph for this function:

template<class Key , class Value >

tBoolean CORE_SharedPointersKVMap< Key, Value >::removeValue ( boost::shared_ptr< Value > & k )

remove the value

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

References CORE_SharedPointersList< T >::size(), and tBoolean.

Here is the call graph for this function:

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

set the type of the object

Referenced by CORE_CommandLine::CORE_CommandLine(), CORE_IO::CORE_IO(), GPM_2DSnowGraph::GPM_2DSnowGraph(), GPM_BGLTest::GPM_BGLTest(), GPM_ClassFactory::GPM_ClassFactory(), GPM_ConwayFunction::GPM_ConwayFunction(), GPM_ConwayGraph::GPM_ConwayGraph(), GPM_CoreRun::GPM_CoreRun(), GPM_CoreTest::GPM_CoreTest(), GPM_Edge::GPM_Edge(), GPM_ExamplesRun::GPM_ExamplesRun(), GPM_Function::GPM_Function(), GPM_Graph::GPM_Graph(), GPM_GraphElement::GPM_GraphElement(), GPM_ModelGraph::GPM_ModelGraph(), GPM_Node::GPM_Node(), GPM_Object::GPM_Object(), GPM_PatternFunction::GPM_PatternFunction(), GPM_Port::GPM_Port(), GPM_PortGraph::GPM_PortGraph(), GPM_Snow2DFunction::GPM_Snow2DFunction(), GPM_Snow3DFunction::GPM_Snow3DFunction(), GPM_Vertex::GPM_Vertex(), and MATH_ExpressionRun::MATH_ExpressionRun().

Here is the caller graph for this function:

template<class Key, class Value>

int CORE_SharedPointersKVMap< Key, Value >::size ( ) const

inline

return the size of the array

virtual void CORE_Object::toDoAfterThisSetting ( )

inlineprotectedvirtualinherited

method called after setThis() method this method can oly be called once.

Reimplemented in GPM_2DSnowGraph, GPMG_EnvironmentWindow, GPM_GraphElement, GPM_ModelFunction, GPM_ModelGraph, GPMG_RuleGraphWindow, GPMG_MovieGraphWindow, GPMG_ShowGraphWindow, and GPM_Function.

Referenced by CORE_Object::setThis(), GPM_ModelGraph::toDoAfterThisSetting(), GPM_GraphElement::toDoAfterThisSetting(), and GPM_2DSnowGraph::toDoAfterThisSetting().

Here is the caller graph for this function:

template<class K , class V >

tString CORE_SharedPointersKVMap< K, V >::toString ( ) const

virtual

return the string representation of the object node

Returns: the string representation of the object node

Reimplemented from CORE_Object.

References CORE_SharedPointersList< T >::size(), CORE_Object::toString(), and tString.

Here is the call graph for this function:

template<class Key, class Value>

void CORE_SharedPointersKVMap< Key, Value >::values ( CORE_SharedPointersList< Value > & vals ) const

inline

return an array of values

References CORE_SharedPointersKVMap< Key, Value >::getValues().

Here is the call graph for this function:

template<class Key, class Value>

void CORE_SharedPointersKVMap< Key, Value >::values ( CORE_Vector< Value * > & vals ) const

inline

return an array of values

References CORE_SharedPointersKVMap< Key, Value >::getValues().

Here is the call graph for this function:

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:

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

template<class Key, class Value> class CORE_SharedPointersKVMap< Key, Value >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Key, class Value>
class CORE_SharedPointersKVMap< Key, Value >