All Frameworks Class Hierarchy This Framework Next Indexes
CATAnalysisVisuInterfaces Interface CATISPMProcess
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATISPMProcess
Usage: you can freely reimplement this interface.
interface CATISPMProcess
Analysis process general informations.
Role: Interface designed to manage Analysis process behaviour.
A process is a mathematical operation applied on the values stored in a
CATAnalysisCharacCollector (or several) in order to create a new one (or several).
This interface manages all general methods related to the process management. The
parameters of the processes are managed by CATISPMProcessAccess.
- See also:
- CATISPMProcessAccess, CATAnalysisCharacCollector
Method Index
- o
GetAvailableInputEntityType(int&,CATSamValue*&)
- Give the Input entity types that are supported by the process.
- o
GetAvailableInputMathDimension(int&,int*&)
- Give the Input mathematical dimension types that are supported by the process.
- o
GetAvailableInputMathType(int&,CATSamMathType*&)
- Give the Input mathematical types that are supported by the process.
- o
GetAvailableInputRefFrame(int&,CATSamRefFrame*&)
- Give the Input reference frame types that are supported by the process.
- o
GetAvailableInputValueType(int&,CATSamValue*&)
- Give the Input Value types that are supported by the process.
- o
GetEntityList(CATAnalysisExplicitParent&,char*,CATSamValue,char*&,CATSamValue&)
- Give the entity list on which values can be computed by the process according to an input list.
- o
GetOutputCharac(CATAnalysisCharacCollector**&,int&,char*,CATAnalysisCharacCollector* const*,int)
- Create the output characteristic(s) according to the input one.
- o
GetOutputCharacType(CATSamCharacVersion&,CATSamCharacVersion&)
- Give the output characteristic version that will be created according to the input one.
- o
GetProcessName()
- Returns the process name.
- o
IsInputCharacTypeAvailable(CATSamCharacVersion&)
- Test if the CATSamCharacVersion can be supported by the process.
- o
IsLinear(CATBoolean&)
- Inform is the data returned by the process can be processed by linear interpolation
This information is usefull for dynamic animation.
- o
SetProcessDataAccess(CATISPMProcessAccess_var&)
- Initialize the CATISPMProcess_access associated to the process.
Methods
o GetAvailableInputEntityType
-
Give the Input entity types that are supported by the process.
- Parameters:
-
- oNbType
- Number of supported entity type
- oEntityType
- List of supported entity type
- See also:
- CATSamValue
o GetAvailableInputMathDimension
public virtual HRESULT GetAvailableInputMathDimension( | int& | oNbType, |
| int*& | oMathDimension) = 0 |
-
Give the Input mathematical dimension types that are supported by the process.
- Parameters:
-
- oNbType
- Number of supported Value types
- oMathDimension
- List of supported mathematical dimension
o GetAvailableInputMathType
-
Give the Input mathematical types that are supported by the process.
- Parameters:
-
- oNbType
- Number of supported mathematical types
- oMathType
- List of supported mathematical types
- See also:
- CATSamMathType
o GetAvailableInputRefFrame
-
Give the Input reference frame types that are supported by the process.
- Parameters:
-
- oNbType
- Number of supported reference frame
- oRefFrame
- List of supported reference frame
- See also:
- CATSamRefFrame
o GetAvailableInputValueType
-
Give the Input Value types that are supported by the process.
- Parameters:
-
- oNbType
- Number of supported Value types
- oValueType
- List of supported Value types
o GetEntityList
-
Give the entity list on which values can be computed by the process according to an input list.
- Parameters:
-
- iContext
- Context for the entities definition it is the Explicit set or entity.
- iEntityFlag
- Inut list of flags to set up if values are defined on the entities.
- iEntityType
- Entity type of the entities.
- oEntityFlag
- Output list of flags to set up if values are defined on the entities.
- oEntityType
- Entity type of the entities that will be returned.
- Returns:
- Status of the process execution .
Legal values: S_OK if the execution is OK ,E_FAIL otherwise.
o GetOutputCharac
public virtual HRESULT GetOutputCharac( | CATAnalysisCharacCollector**& | oCharac, |
| int& | oNbCharac, |
| const char* | iEntityFlag, |
| const CATAnalysisCharacCollector* const* | iCharac, |
| int | iNbCharac) = 0 |
-
Create the output characteristic(s) according to the input one.
This is the execution of the process.
- Parameters:
-
- oCharac
- Array of created CATAnalysisCharacCollector
- oNbCharac
- Size of this array.
- iEntityFlag
- Entity flag that inform if values have to be computed of the support.
- iCharac
- Input list of CATAnalysisCharacCollector to process.
- iNbCharac
- Size of this input array.
- Returns:
- Status of the process execution .
Legal values: S_OK if the execution is OK ,E_FAIL otherwise.
o GetOutputCharacType
-
Give the output characteristic version that will be created according to the input one.
- Parameters:
-
- iVersion
- Characteristic version as input of the process.
- oVersion
- Characteristic version that will be created by the process.
- Returns:
- Status of the test.
Legal values: S_OK if iVersion is supported,E_FAIL otherwise.
- See also:
- CATSamCharacVersion
o GetProcessName
-
Returns the process name.
o IsInputCharacTypeAvailable
-
Test if the CATSamCharacVersion can be supported by the process.
- Parameters:
-
- iVersion
- Characteristic version to test
- Returns:
- Status of the test.
Legal values: S_OK if iVersion is supported,E_FAIL otherwise.
- See also:
- CATSamCharacVersion
o IsLinear
-
Inform is the data returned by the process can be processed by linear interpolation
This information is usefull for dynamic animation.
- Parameters:
-
- oresult
- Entity type of the entities that will be returned.
Legal values: CATTrue if the execution is linear ,CATFalse otherwise.
o SetProcessDataAccess
public virtual void SetProcessDataAccess( | CATISPMProcessAccess_var& | iProcessAccess) = 0 |
-
Initialize the CATISPMProcess_access associated to the process.
- Parameters:
-
- iProcessAccess
- CATISPMProcessAccess
This object is included in the file: CATISPMProcess.h
If needed, your Imakefile.mk should include the module: CATSamVisuUUID