All Categories Class Hierarchy This Category Previous Next Indexes
Miscellaneous Class CATDMUsrMethodContext
CATDMUsrMethodContext
public class CATDMUsrMethodContext
Usage note :
Add library LV001BAS as prereq for link
Method Index
- o
GetActionId(char**)
- GetActionId ()
Get the id of the current action
- o
GetCurrentMatrix(double[12])
- GetCurrentMatrix ()
Get the current matrix
- o
GetEnvironment(char**)
-
- o
GetSource()
-
- o
GetTaskCaller(TaskType&)
- GetTaskCaller()
Get current execution context.
- o
IsVPMSessionInteractive()
- IsVPMSessionInteractive ()
Tells whether the VPM session is an interactive one or a server one
- o
WhereAmI()
- Returns in which panel you are at this moment.
Methods
o GetActionId
| public static int GetActionId( | char** | oActionId) |
-
GetActionId ()
Get the id of the current action
- Parameters:
-
- oActionId
- Id of the current action, primary or secondary according to user settings
- Returns:
- 1 if action id is set, 0 otherwise
o GetCurrentMatrix
| public static int GetCurrentMatrix( | double[12] | oMat) |
-
GetCurrentMatrix ()
Get the current matrix
- Parameters:
-
- oMat
- matrix
- Returns:
- 1 if ko (when bad use)
0 if ok
WARNING: only available in CATDMUsrMethod::xx (xx=AuthorizedPaste, AuthorizedMove & AuthorizedReplace
o GetEnvironment
| public static void GetEnvironment( | char** | oEnv) |
-
o GetSource
| public static ObjID GetSource( | ) |
-
o GetTaskCaller
| public static int GetTaskCaller( | TaskType& | oType) |
-
GetTaskCaller()
Get current execution context.
- Parameters:
-
- oType
- Current context (see enumeration above).
- Returns:
- 1 if context is currently set, 0 otherwise.
o IsVPMSessionInteractive
| public static int IsVPMSessionInteractive( | ) |
-
IsVPMSessionInteractive ()
Tells whether the VPM session is an interactive one or a server one
- Returns:
- 1 if the VPM session is an interactive one
0 if the VPM session is a server-based one
o WhereAmI
-
Returns in which panel you are at this moment.
WARNING: only available in CATDMUsrMethod::Open.
This object is included in the file: CATDMUsrMethodContext.h
If needed, your Imakefile.mk should include the module: LV001BAS