C++ main module for gpm Package  1.0
GPM_CompositorFunction.h
Go to the documentation of this file.
1 #ifndef GPM_CompositorFunction_H
2 #define GPM_CompositorFunction_H
3 
4 
5 #include "CORE_IO.h"
6 #include "GPM_Object.h"
7 
19 
20  SP_OBJECT(GPM_CompositorFunction);
21  // ATTRIBUTES
22 
23 public:
24 
25 
26 
27 private:
28 
29 
30 protected:
31  // METHODS
32 
33  // CONSTRUCTORS
34 
38  }
39 
40 
41 
42  // DESTRUCTORS
43 
44 
47  virtual ~GPM_CompositorFunction(void) {
48  }
49 
50 
51 public:
52 
53  // NEW Method
54  //===========
55 
58  virtual SP::GPM_CompositorFunction NewInstance() const =0;
59 
60 
61 
62 
63 
64  // SET Methods
65  // ===========
66 
69  virtual void copy(const GPM_CompositorFunction& cf)=0;
70 
73  virtual void parse(const tString& signature)=0;
76  virtual void setName(const tString& name)=0;
79  virtual int addParameter(const tString& name,const tFlag& tye,const tFlag& card,const tBoolean& isConst)=0;
82  virtual void removeParameter(const int& index)=0;
85  virtual void moveUpParameter(const int& index)=0;
88  virtual void moveDownParameter(const int& index)=0;
91  virtual void setBody(const tString& body)=0;
94  virtual void setReturnType(const tFlag& retType)=0;
95 
96 
97 
98  // GET Methods
99  // ===========
100 
101 
104  virtual tString getName() const=0;
105 
108  virtual tString getBody() const=0;
109 
112  virtual int getParametersNumber() const=0;
113 
116  virtual tString getParameterName(const int& i) const=0;
119  virtual tFlag getParameterType(const int& i) const=0;
122  virtual tFlag getParameterMultiplicity(const int& i) const=0;
125  virtual tBoolean isConstParameter(const int& i) const=0;
128  virtual tString getSignature() const=0;
131  virtual tFlag getReturnType() const=0;
132 
135  virtual int getParameter(const tString& name) const=0;
136 
139  virtual tBoolean doParameterExist(const tString& parName) const=0;
140 
141 };
142 
143 #endif
GPM_CompositorFunction(void)
create
Definition: GPM_CompositorFunction.h:37
virtual void copy(const GPM_CompositorFunction &cf)=0
copy a function
virtual tString getSignature() const =0
get the parameter signature of the function
virtual void moveUpParameter(const int &index)=0
move up the parameter
virtual void setName(const tString &name)=0
set the name of the function
virtual SP::GPM_CompositorFunction NewInstance() const =0
create a calculator
virtual tString getName() const =0
get the name of the function
#define tBoolean
Definition: types.h:35
DEFINE_SVPTR(GPM_CompositorFunction)
virtual tFlag getReturnType() const =0
get the retur ntype of the function
virtual void setReturnType(const tFlag &retType)=0
set the retrun type of the function
This class describes a compositor function used in rules.
Definition: GPM_CompositorFunction.h:18
virtual tBoolean isConstParameter(const int &i) const =0
get the modified type of the i-th parameter of the function
virtual int getParameter(const tString &name) const =0
get the parameter index with name
virtual tString getParameterName(const int &i) const =0
get the name of the i-th parameter of the function
virtual tFlag getParameterType(const int &i) const =0
get the type of the i-th parameter of the function
virtual void setBody(const tString &body)=0
set the body of the function
#define tString
Definition: types.h:36
virtual tString getBody() const =0
get the body of the function
virtual ~GPM_CompositorFunction(void)
destroy
Definition: GPM_CompositorFunction.h:47
virtual void parse(const tString &signature)=0
parse the function definition
virtual int getParametersNumber() const =0
get the number of parameters of the function
virtual tBoolean doParameterExist(const tString &parName) const =0
return true if the parameter with name already exists
virtual void moveDownParameter(const int &index)=0
move down the parameter
This class is the base class of all graph classes.
Definition: GPM_Object.h:17
virtual tFlag getParameterMultiplicity(const int &i) const =0
get the cardinality of the i-th parameter of the function
virtual int addParameter(const tString &name, const tFlag &tye, const tFlag &card, const tBoolean &isConst)=0
add a parameter of the function
DEFINE_SPTR(GPM_CompositorFunction)
virtual void removeParameter(const int &index)=0
remove the parameter at index of the function
#define tFlag
Definition: types.h:14