This class describes a compositor function used in rules. More...

#include <GPM_CompositorFunction.h>

Inheritance diagram for GPM_CompositorFunction:

Collaboration diagram for GPM_CompositorFunction:

Public Member Functions
virtual SP::GPM_CompositorFunction	NewInstance () const =0
	create a calculator More...

virtual void	copy (const GPM_CompositorFunction &cf)=0
	copy a function More...

virtual void	parse (const tString &signature)=0
	parse the function definition More...

virtual void	setName (const tString &name)=0
	set the name of the function More...

virtual int	addParameter (const tString &name, const tFlag &tye, const tFlag &card, const tBoolean &isConst)=0
	add a parameter of the function More...

virtual void	removeParameter (const int &index)=0
	remove the parameter at index of the function More...

virtual void	moveUpParameter (const int &index)=0
	move up the parameter More...

virtual void	moveDownParameter (const int &index)=0
	move down the parameter More...

virtual void	setBody (const tString &body)=0
	set the body of the function More...

virtual void	setReturnType (const tFlag &retType)=0
	set the retrun type of the function More...

virtual tString	getName () const =0
	get the name of the function More...

virtual tString	getBody () const =0
	get the body of the function More...

virtual int	getParametersNumber () const =0
	get the number of parameters of the function More...

virtual tString	getParameterName (const int &i) const =0
	get the name of the i-th parameter of the function More...

virtual tFlag	getParameterType (const int &i) const =0
	get the type of the i-th parameter of the function More...

virtual tFlag	getParameterMultiplicity (const int &i) const =0
	get the cardinality of the i-th parameter of the function More...

virtual tBoolean	isConstParameter (const int &i) const =0
	get the modified type of the i-th parameter of the function More...

virtual tString	getSignature () const =0
	get the parameter signature of the function More...

virtual tFlag	getReturnType () const =0
	get the retur ntype of the function More...

virtual int	getParameter (const tString &name) const =0
	get the parameter index with name More...

virtual tBoolean	doParameterExist (const tString &parName) const =0
	return true if the parameter with name already exists 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 void	turnBodyTextToLine (tString &bdy)

static void	turnBodyLineToText (tString &bdy)

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
	GPM_CompositorFunction (void)
	create More...

virtual	~GPM_CompositorFunction (void)
	destroy More...

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

This class describes a compositor function used in rules.

Author: Stephane Despreaux

Version: 1.0

Constructor & Destructor Documentation

GPM_CompositorFunction::GPM_CompositorFunction ( void )

inlineprotected

create

virtual GPM_CompositorFunction::~GPM_CompositorFunction ( void )

inlineprotectedvirtual

destroy

Member Function Documentation

virtual int GPM_CompositorFunction::addParameter	(	const tString &	name,
		const tFlag &	tye,
		const tFlag &	card,
		const tBoolean &	isConst
	)

pure virtual

add a parameter of the function

Referenced by GPMG_FunctionWindow::componentClicked().

Here is the caller graph for this function:

virtual void GPM_CompositorFunction::copy ( const GPM_CompositorFunction & cf )

pure virtual

copy a function

virtual tBoolean GPM_CompositorFunction::doParameterExist ( const tString & parName ) const

pure virtual

return true if the parameter with name already exists

virtual tString GPM_CompositorFunction::getBody ( ) const

pure virtual

get the body of the function

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:

virtual tString GPM_CompositorFunction::getName ( ) const

pure virtual

get the name of the function

static ostream& CORE_Object::getOutput ( )

inlinestaticinherited

get output

virtual int GPM_CompositorFunction::getParameter ( const tString & name ) const

pure virtual

get the parameter index with name

virtual tFlag GPM_CompositorFunction::getParameterMultiplicity ( const int & i ) const

pure virtual

get the cardinality of the i-th parameter of the function

virtual tString GPM_CompositorFunction::getParameterName ( const int & i ) const

pure virtual

get the name of the i-th parameter of the function

virtual int GPM_CompositorFunction::getParametersNumber ( ) const

pure virtual

get the number of parameters of the function

!

virtual tFlag GPM_CompositorFunction::getParameterType ( const int & i ) const

pure virtual

get the type of the i-th parameter of the function

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:

virtual tFlag GPM_CompositorFunction::getReturnType ( ) const

pure virtual

get the retur ntype of the 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

virtual tString GPM_CompositorFunction::getSignature ( ) const

pure virtual

get the parameter signature of the function

template<class T >

static tString CORE_Object::getTypeName ( )

inlinestaticinherited

get type name

References tString.

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:

virtual tBoolean GPM_CompositorFunction::isConstParameter ( const int & i ) const

pure virtual

get the modified type of the i-th parameter of the 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:

virtual void GPM_CompositorFunction::moveDownParameter ( const int & index )

pure virtual

move down the parameter

Referenced by GPMG_FunctionWindow::componentClicked().

Here is the caller graph for this function:

virtual void GPM_CompositorFunction::moveUpParameter ( const int & index )

pure virtual

move up the parameter

Referenced by GPMG_FunctionWindow::componentClicked().

Here is the caller graph for this function:

virtual SP::GPM_CompositorFunction GPM_CompositorFunction::NewInstance ( ) const

pure virtual

create a calculator

Referenced by GPMG_FunctionWindow::setFunctions(), and GPMG_Project::setGlobalFunctions().

Here is the caller 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:

virtual void GPM_CompositorFunction::parse ( const tString & signature )

pure virtual

parse the function definition

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:

virtual void GPM_CompositorFunction::removeParameter ( const int & index )

pure virtual

remove the parameter at index of the function

Referenced by GPMG_FunctionWindow::componentClicked().

Here is the caller graph for this function:

virtual void GPM_CompositorFunction::setBody ( const tString & body )

pure virtual

set the body of the function

virtual void GPM_CompositorFunction::setName ( const tString & name )

pure virtual

set the name of the function

static void CORE_Object::setOutput ( ostream & out )

inlinestaticinherited

set output

virtual void GPM_CompositorFunction::setReturnType ( const tFlag & retType )

pure virtual

set the retrun type of the function

Referenced by GPMG_FunctionWindow::componentClicked().

Here is the caller graph for this function:

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:

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:

tString CORE_Object::toString ( ) const

virtualinherited

return the string representation of the object node

Returns: the string representation of the object node

Reimplemented in CORE_Time, CORE_Vector< T >, CORE_Array< T >, GPM_PatternFunction, GPM_Graph, CORE_Array2D< T >, GPM_GraphElement, MATH_Variable, CORE_Color, CORE_Matrix< T >, GPM_ModelFunction, CORE_SharedPointersVMap< Key, Value >, CORE_SharedPointersVMap< tString, const CORE_Object >, CORE_SharedPointersVMap< tString, CORE_Object >, CORE_SharedPointersListVMap< Key, Value >, GPM_Rule, CORE_SharedPointersKVMap< Key, Value >, GPM_Variable, GPM_Vertex, MATH_Environment, MATH_ParentExpression, MATH_RootExpression, MATH_LeafExpression, CORE_String, MATH_FunctionNode, CORE_Integer, GPM_Edge, CORE_Array3D< T >, GPM_Port, GPM_Node, MATH_UnaryOperator, CORE_Complex, MATH_BinaryOperator, and CORE_Real.

References CORE_Object::getIdentityString().

Referenced by CORE_Object::print(), MATH_ParentExpression::toString(), CORE_SharedPointersKVMap< Key, Value >::toString(), CORE_SharedPointersListVMap< Key, Value >::toString(), CORE_SharedPointersVMap< Key, Value >::toString(), and GPM_PatternFunction::toString().

Here is the call graph for this function:

Here is the caller graph for this function:

static void GPM_Object::turnBodyLineToText ( tString & bdy )

inlinestaticinherited

brief turn the body from the line to text

References CORE_String::replaceAll().

Referenced by GPMG_Project::loadFromUIClass(), and GPM_ModelFunction::readRulesFromFile().

Here is the call graph for this function:

Here is the caller graph for this function:

static void GPM_Object::turnBodyTextToLine ( tString & bdy )

inlinestaticinherited

brief turn the body from the text to line

References CORE_String::replaceAll().

Referenced by GPM_ModelFunction::saveRulesToFile(), and GPMG_Project::saveToUIClass().

Here is the call graph for this function:

Here is the caller 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 file:

GPM_CompositorFunction.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation