All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisVisuInterfaces Interface CATISPMProcessAccess

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATISPMProcessAccess
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISPMProcessAccess

Analysis process parameters.
Role: Interface designed to manage Analysis process parameters access.

A process is a mathematical operation applied on the values stored in a CATAnalysisCharacCollector in order to create a new one. This interface manages the numerical parameters of the process.
For example, for a linear process will return 2 real parameters (A,B) to compute y = Ax+B.

See also:
CATISPMProcess, CATAnalysisCharacCollector


Method Index


o GetCharParameter(CATUnicodeString*&,int&)
Retrieves the parameters data associated to Process_access set as chars.
o GetClone()
Returns a clone process version (copy version).
o GetFloatParameter(float*&,int&)
Retrieves the parameters data associated to Process_access set as floats.
o GetIntParameter(int*&,int&)
Retrieves the parameters data associated to Process_access set as integers.
o GetNameParameter(CATUnicodeString*&,int&)
Retrieves the parameters names associated to Process_access.
o GetProcess(CATISPMProcess_var&)
Returns the associated process.
o GetProcessName(CATString&)
Returns the process name.
o SetCharParameter(CATUnicodeString*,int)
Initialize the parameters data associated to Process_access set as chars.
o SetFloatParameter(float*,int)
Initialize the parameters data associated to Process_access set as floats.
o SetIdenticalWith(CATISPMProcessAccess_var&)
Set the parameters as identicial to another process.
o SetIntParameter(int*,int)
Initialize the parameters data associated to Process_access set as integers.
o SetNameParameter(CATUnicodeString*,int)
Defines the parameters names associated to Process_access.
o SetProcessName(CATString&)
Defines the process name.

Methods


o GetCharParameter
public virtual HRESULT GetCharParameter(CATUnicodeString*& oTabChar,
int& oNbChar) = 0
Retrieves the parameters data associated to Process_access set as chars.
Parameters:
oTabChar
Array of CATUnicodeString
oNbChar
Size of the array of CATUnicodeString
o GetClone
public virtual CATISPMProcessAccess_var GetClone()= 0
Returns a clone process version (copy version).
o GetFloatParameter
public virtual HRESULT GetFloatParameter(float*& oTabFloat,
int& oNbFloat) = 0
Retrieves the parameters data associated to Process_access set as floats.
Parameters:
oTabFloat
Array of Float
oNbFloat
Size of the array of Floats
o GetIntParameter
public virtual HRESULT GetIntParameter(int*& oTabInt,
int& oNbInt) = 0
Retrieves the parameters data associated to Process_access set as integers.
Parameters:
oTabInt
Array of integers
oNbInt
Size of the array of integers
o GetNameParameter
public virtual HRESULT GetNameParameter(CATUnicodeString*& oTabName,
int& oNbName) = 0
Retrieves the parameters names associated to Process_access.
Parameters:
oTabName
Array of CATUnicodeString
oNbName
Size of the array of CATUnicodeString
o GetProcess
public virtual HRESULT GetProcess(CATISPMProcess_var& oProcess) =0
Returns the associated process.
Parameters:
oProcess
Process associated.
o GetProcessName
public virtual HRESULT GetProcessName(CATString& oName) = 0
Returns the process name.
Parameters:
oName
CATUnicodeString as name.
o SetCharParameter
public virtual HRESULT SetCharParameter( const CATUnicodeString* iTabChar,
int iNbChar) = 0
Initialize the parameters data associated to Process_access set as chars.
Parameters:
iTabChar
Array of CATUnicodeString
iNbChar
Size of the array of CATUnicodeString
o SetFloatParameter
public virtual HRESULT SetFloatParameter( const float* iTabFloat,
int iNbFloat) = 0
Initialize the parameters data associated to Process_access set as floats.
Parameters:
iTabFloat
Array of Float
iNbFloat
Size of the array of Floats
o SetIdenticalWith
public virtual HRESULT SetIdenticalWith(CATISPMProcessAccess_var& iOriginal) = 0
Set the parameters as identicial to another process.
Parameters:
iOriginal
Process for comparison
o SetIntParameter
public virtual HRESULT SetIntParameter( const int* iTabInt,
int iNbInt) = 0
Initialize the parameters data associated to Process_access set as integers.
Parameters:
iTabInt
Array of integers
iNbInt
Size of the array of integers
o SetNameParameter
public virtual HRESULT SetNameParameter( const CATUnicodeString* iTabName,
int iNbName) = 0
Defines the parameters names associated to Process_access.
Parameters:
iTabName
Array of CATUnicodeString
iNbName
Size of the array of CATUnicodeString
o SetProcessName
public virtual HRESULT SetProcessName( const CATString& iName) = 0
Defines the process name.
Parameters:
iName
CATUnicodeString as name.

This object is included in the file: CATISPMProcessAccess.h
If needed, your Imakefile.mk should include the module: CATSamVisuUUID

Copyright © 2003, Dassault Systèmes. All rights reserved.