All Frameworks Class Hierarchy This Framework Previous Next Indexes
KnowledgeInterfaces Interface CATICkeArg
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICkeArg
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICkeArg
Interface to manage signatures formal arguments.
Role: An argument belongs to a signature.
It describes the type of parameters that will be given to the function at runtime.
It is used to check syntax validity.
Example: in signature "sin (x:In Real)" the only argument is "x: In Real".
- See also:
- CATICkeSignature
Method Index
- o
GetMode()
- Returns the mode of the argument.
- o
Name()
- Returns the NLS name of the argument.
- o
Rename(CATUnicodeString&)
- Renames the argument.
- o
SetMode(CATICkeArg::Mode)
- Sets the mode of the argument.
- o
Show()
- Returns the NLS string to be shown to the user to describe the argument.
- o
Type()
- Returns the type of the argument.
Enumerated Type Index
- o
Mode
- Enum describing the argument mode.
Methods
o GetMode
public virtual CATICkeArg::Mode GetMode( | )const = 0 |
-
Returns the mode of the argument.
Legal values: the mode can be either
In when parameter will be used as an input.
Out when parameter will be used as an output.
o Name
-
Returns the NLS name of the argument.
Example: "x"
o Rename
-
Renames the argument.
- Parameters:
-
- iNewName
- new name to be given to the argument
o SetMode
public virtual void SetMode( | const CATICkeArg::Mode | iMode) = 0 |
-
Sets the mode of the argument.
- Parameters:
-
- iMode
- mode of the argument.
- In : for a parameter in input
- Out : for a parameter in output
- InOut : for a parameter in output and input
o Show
-
Returns the NLS string to be shown to the user to describe the argument.
Use it whenever you want to show an argument to the user (instead of name).
Example: " x : In Real".
o Type
-
Returns the type of the argument.
Example: Real
Enumerated Types
o Mode
-
enum Mode {
Undefined,
In,
Out,
InOut
}
Enum describing the argument mode. It explains if parameter will be read or written
This object is included in the file: CATICkeArg.h
If needed, your Imakefile.mk should include the module: KnowledgeItf