All Frameworks Class Hierarchy This Framework Indexes
CATAnalysisVisuInterfaces Interface CATISamImageAxisSystem
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATISamImageAxisSystem
Analysis Images modification.
Role: Analysis Images are computed by default in the global axis system.
Query this interface to modify the axis system ( definition, coordinate system, ...)
Method Index
- o
GetAxisSystemDef(CATMathAxis&)
- Retrieves the mathematical definition of the current axis system.
- o
GetAxisSystemType(CATSamAxisSystemType&)
- Retrieves the current axis system type used for image computation
- o
GetAxisSystemType(CATUnicodeString&)
- Retrieves the current axis system NLS type used for image computation
- o
GetCoordinateSystem(CATSamCoordinateSystem&)
- Retrieves the current coordinate system type
- o
GetUserAxisSystem(CATISamAnalysisAxis_var&)
- Retrieves the pointed CATISamAnalysisAxis object for "User" axis system.
- o
GetUserAxisSystem(CATBaseUnknown_var&,CATILinkableObject_var&)
- Retrieves the pointed CATISamAnalysisAxis or CATIPrdPublication object for "User" axis system.
- o
SetAxisSystemDef(CATMathAxis&)
- Set the mathematical definition of the current axis system for "Manual" axis system.
- o
SetAxisSystemType(CATSamAxisSystemType)
- Set the current axis system type
- o
SetCoordinateSystem(CATSamCoordinateSystem)
- Set the current coordinate system type
- o
SetUserAxisSystem(CATBaseUnknown_var,CATILinkableObject_var)
- Sets the pointed CATISamAnalysisAxis object for "User" axis system.
Methods
o GetAxisSystemDef
| public virtual GetAxisSystemDef( | | oAxis) |
-
Retrieves the mathematical definition of the current axis system.
Origin coordinates is given in MKS unit.
- Parameters:
-
- oAxis
- a reference to a CATMathAxis that will be filled with the current axis system definition
- See also:
- CATMathAxis
o GetAxisSystemType
| public virtual GetAxisSystemType( | | oAxisType) |
-
Retrieves the current axis system type used for image computation
- Parameters:
-
- oAxisType
- the type of definition for the current axis system ( manual , user , ... )
- See also:
- CATSamAxisSystemType
o GetAxisSystemType
| public virtual GetAxisSystemType( | | oAxisType) |
-
Retrieves the current axis system NLS type used for image computation
- Parameters:
-
- oAxisType
- the NLS string associated to the axis system type
o GetCoordinateSystem
| public virtual GetCoordinateSystem( | | oCoordSystem) |
-
Retrieves the current coordinate system type
- Parameters:
-
- oCoordSystem
- to know if the axis is cartesian,cylindrical or spherical
- See also:
- CATSamCoordinateSystem
o GetUserAxisSystem
| public virtual GetUserAxisSystem( | | oUserAxis) |
-
Retrieves the pointed CATISamAnalysisAxis object for "User" axis system.
- Parameters:
-
- oUserAxis
- a handler on a CATISamAnalysisAxis interface.
- See also:
- CATISamAnalysisAxis
o GetUserAxisSystem
| public virtual GetUserAxisSystem( | | oUserAxis, |
| | oLinkedPrd) |
-
Retrieves the pointed CATISamAnalysisAxis or CATIPrdPublication object for "User" axis system.
- Parameters:
-
- oUserAxis
- a handler on a the User axis system.
- oLinkedPrd
- a handler on the CATILinkableObject for positionning.
- See also:
- CATISamAnalysisAxis
o SetAxisSystemDef
| public virtual SetAxisSystemDef( | const | iAxis) |
-
Set the mathematical definition of the current axis system for "Manual" axis system.
Origin coordinates must be given in MKS unit.
- Parameters:
-
- oAxis
- a reference to a CATMathAxis
- See also:
- CATMathAxis
o SetAxisSystemType
| public virtual SetAxisSystemType( | | iAxisType) |
-
Set the current axis system type
- Parameters:
-
- iAxisType
- the type of definition for the current axis system ( manual , user , ... )
- See also:
- CATSamAxisSystemType
o SetCoordinateSystem
| public virtual SetCoordinateSystem( | | iCoordSystem) |
-
Set the current coordinate system type
- Parameters:
-
- oCoordSystem
- to know if the axis is cartesian,cylindrical or spherical
- See also:
- CATSamCoordinateSystem
o SetUserAxisSystem
| public virtual SetUserAxisSystem( | | iUserAxis, |
| | iLinkedPrd) |
-
Sets the pointed CATISamAnalysisAxis object for "User" axis system.
- Parameters:
-
- iUserAxis
- a handler on the pointed axis system which can be a CATISamAnalysisAxis or CATIPrdPublication.
Note that only the origin and vectors definitions are taken into account.
- iLinkedPrd
- a handler on the CATILinkableObject for positionning.
- See also:
- CATISamAnalysisAxis
This object is included in the file: CATISamImageAxisSystem.h
If needed, your Imakefile.mk should include the module: CATSamVisuUUID