All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ManufacturingInterfaces Interface CATIMfgDirection

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

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


interface CATIMfgDirection

Interface dedicated to machining direction management.
Role: This interface offers services mainly to manage the MfgDirection object


Method Index


o Evaluate()
Update the results of the Machining Direction object.
o GetActivity(CATIMfgActivity_var&)
Gets activity to which machining direction belongs.
o GetCurrentOrigin(int&)
Gets Machining Direction current origin.
o GetDirection(CATMathDirection&)
Gets the Direction of the Machining Direction Object.
o GetFlagModif(int&)
Gets the parameter defining if the Machining Direction has been modified or not.
o GetGeometries(int,CATLISTP(CATGeometry)&)
Gets the geometries attached to the Machining Direction.
o GetGeometry(CATBaseUnknown_var&)
GEts the elemnt associated to the Machining Direction.
o GetInvertStatus(int&)
Gets Machining Direction Inversion status.
o GetMode(CATUnicodeString&)
Gets the definition mode of the Machining Direction Object.
o GetOrigin(CATMathPoint&)
Gets Machining Direction origin.
o GetOriginMode(int&)
Gets Machining Direciton origin mode.
o GetSelectedGeometry(CATBaseUnknown_var&)
Gets the geometry associated to the Machining Direction Object.
o GetSelectionMode2Rotations(int&)
Gets Two Rotations selection mode.
o GetSelectionModeAxis(int&)
Gets Axis selection mode.
o GetSelectionModeManual(int&)
Gets Manual selection mode.
o GetSelectionModeNormalBottom(int&)
Gets Normal To Bottom selection mode.
o GetSelectionModeNormalView(int&)
Gets Normal To View selection mode.
o GetSelectionModePtView(int&)
Gets Pont in The View selection mode.
o GetSelectionModeSelection(int&)
Gets Selection selection mode.
o GetStatus(CATUnicodeString&,CATUnicodeString&,int&,CATUnicodeString*)
Gets Machining Direction status.
o GetTransformation(CATMathTransformation&)
Gets Machining Direction transformation matrix.
o GetVector(CATMathDirection&)
Gets Machining Direction Vector.
o GetVector(double&,double&,double&)
Gets Machining Direction Vector.
o GetVisuTransformation(CATMathTransformation&,CATMathTransformation&)
Gets the visualization transformation of the Machining Direction object.
o InvertDirection()
Machining machining direction.
o IsDrivenByRelation()
Indicates if one of the parameter of the direction is a result of a CKE relation.
o IsValid(int&,int)
Checks if Machining Direction is valid.
o NullifyVector()
Resets vector definition.
o SetActivity(CATIMfgActivity_var&)
Sets the activity on chich the machining direction is attached (not in the data model, pure run time).
o SetCurrentOrigin(int&)
Sets Machining Direction current origin.
o SetDirection(CATMathDirection&,int)
Sets the direction of the Machining Direction Object.
o SetFlagModif(int&)
Sets the modification flag of the Machining Direction Object.
o SetMode(CATUnicodeString&)
Sets the definition mode of the Machining Direction Object.
o SetOrigin(CATMathPoint&)
Sets Machining Direction origin.
o SetOriginMode(int&)
Sets Machining Direction origin mode.
o SetSelectedGeometry(CATBaseUnknown_var&,CATBaseUnknown_var&)
Sets the geometry associated to the Machining Direction Object.
o SetSelectionMode2Rotations(int)
Sets selection mode to Two Rotations.
o SetSelectionModeAxis(int)
Sets semection mode to Axis.
o SetSelectionModeManual(int)
Sets selection mode to Manual.
o SetSelectionModeNormalBottom(int)
Sets the selection mode to Normal To Bottom.
o SetSelectionModeNormalView(int)
Sets the selection mode to Normal To View.
o SetSelectionModePtView(int)
Sets seleciton mode to Point In the View.
o SetSelectionModeSelection(int)
Sets the selection mode to Selection.
o SetTransformation(CATMathTransformation)
Sets Machining Direction transformation matrix.
o SetVector(CATMathDirection&)
Sets Machining Direction Vector.
o SetVisuTransformation(CATMathTransformation,CATMathTransformation)
Sets the visualization transformation of the Machining Direction object.

Methods


o Evaluate
public virtual HRESULT Evaluate()=0
Update the results of the Machining Direction object.
o GetActivity
public virtual HRESULT GetActivity(CATIMfgActivity_var& oActivity)=0
Gets activity to which machining direction belongs.
Parameters:
oActivity
The activity
o GetCurrentOrigin
public virtual HRESULT GetCurrentOrigin(int& oCurrentOrigin)=0
Gets Machining Direction current origin.
Parameters:
oCurrentOrigin
The current origin
o GetDirection
public virtual HRESULT GetDirection(CATMathDirection& oDirection)=0
Gets the Direction of the Machining Direction Object.
Parameters:
oDirection
The mathematical direction of the object
o GetFlagModif
public virtual HRESULT GetFlagModif(int& oFlag)=0
Gets the parameter defining if the Machining Direction has been modified or not.
Parameters:
oFlag
The flag to get the modification status
o GetGeometries
public virtual HRESULT GetGeometries( const int iMode,
CATLISTP(CATGeometry)& oGeometries)=0
Gets the geometries attached to the Machining Direction.
Parameters:
iMode
The query mode
oGeometries
The resulting geometries
o GetGeometry
public virtual HRESULT GetGeometry(CATBaseUnknown_var& oElement)=0
GEts the elemnt associated to the Machining Direction.
Parameters:
oElement
The referenced element
o GetInvertStatus
public virtual HRESULT GetInvertStatus(int& oStatus)=0
Gets Machining Direction Inversion status.
Parameters:
oStatus
The inversion status
o GetMode
public virtual HRESULT GetMode(CATUnicodeString& oString) const=0
Gets the definition mode of the Machining Direction Object.
Parameters:
oString
The mode
o GetOrigin
public virtual HRESULT GetOrigin(CATMathPoint& oPoint)=0
Gets Machining Direction origin.
Parameters:
oPoint
The mathematical point
o GetOriginMode
public virtual HRESULT GetOriginMode(int& oMode)=0
Gets Machining Direciton origin mode.
Parameters:
oMode
The mode
o GetSelectedGeometry
public virtual HRESULT GetSelectedGeometry(CATBaseUnknown_var& oElement)=0
Gets the geometry associated to the Machining Direction Object.
Parameters:
oElement
The associated geometry
o GetSelectionMode2Rotations
public virtual HRESULT GetSelectionMode2Rotations(int& oMode)=0
Gets Two Rotations selection mode.
Parameters:
oMode
The mode
o GetSelectionModeAxis
public virtual HRESULT GetSelectionModeAxis(int& oMode)=0
Gets Axis selection mode.
Parameters:
oMode
The mode
o GetSelectionModeManual
public virtual HRESULT GetSelectionModeManual(int& oMode)=0
Gets Manual selection mode.
Parameters:
oMode
The mode
o GetSelectionModeNormalBottom
public virtual HRESULT GetSelectionModeNormalBottom(int& oMode)=0
Gets Normal To Bottom selection mode.
Parameters:
oMode
The mode
o GetSelectionModeNormalView
public virtual HRESULT GetSelectionModeNormalView(int& oMode)=0
Gets Normal To View selection mode.
Parameters:
oMode
The mode
o GetSelectionModePtView
public virtual HRESULT GetSelectionModePtView(int& oMode)=0
Gets Pont in The View selection mode.
Parameters:
oMode
The mode
o GetSelectionModeSelection
public virtual HRESULT GetSelectionModeSelection(int& oMode)=0
Gets Selection selection mode.
Parameters:
oMode
The mode
o GetStatus
public virtual HRESULT GetStatus(CATUnicodeString& oName,
CATUnicodeString& oGeoNames,
int& oStatus,
CATUnicodeString* oPubName= NULL) const = 0
Gets Machining Direction status.
Parameters:
oName
The Machining Direction Name
oGeoNames
The Machining Direction Geometric References names
oStatus
The Machining Direction Geometric References status
oPubName
The Machining Direction Geometric References publication names
o GetTransformation
public virtual HRESULT GetTransformation(CATMathTransformation& oTransformation)=0
Gets Machining Direction transformation matrix.
Parameters:
oTransformation
The transformation
o GetVector
public virtual HRESULT GetVector(CATMathDirection& oDirection)=0
Gets Machining Direction Vector.
Parameters:
oDirection
The vector
o GetVector
public virtual HRESULT GetVector(double& oCoordX,
double& oCoordY,
double& oCoordZ)=0
Gets Machining Direction Vector.
Parameters:
oCoordX
The X coordinate of the vector
oCoordY
The Y coordinate of the vector
oCoordZ
The Z coordinate of the vector
o GetVisuTransformation
public virtual HRESULT GetVisuTransformation(CATMathTransformation& oTransForAxis,
CATMathTransformation& oTransForOrigin)=0
Gets the visualization transformation of the Machining Direction object.
Parameters:
iTransForAxis
The transformation for the axis
oTransForOrigin
The transofrmation for the origin
o InvertDirection
public virtual HRESULT InvertDirection()=0
Machining machining direction.
o IsDrivenByRelation
public virtual CATBoolean IsDrivenByRelation()=0
Indicates if one of the parameter of the direction is a result of a CKE relation.
Returns:

Legal values: TRUE At least one parameter is valuated by an active CATICkeRelation. FALSE No parameter is valuated by an active CATICkeRelation .
o IsValid
public virtual HRESULT IsValid(int& oIsValid,
int iIsRequired=1) const = 0
Checks if Machining Direction is valid.
Parameters:
oIsValid
The validity
iIsRequired
The required characteristic of the object
o NullifyVector
public virtual HRESULT NullifyVector()=0
Resets vector definition.
o SetActivity
public virtual HRESULT SetActivity(CATIMfgActivity_var& oActivity)=0
Sets the activity on chich the machining direction is attached (not in the data model, pure run time).
Parameters:
oActivity
The activity
o SetCurrentOrigin
public virtual HRESULT SetCurrentOrigin( const int& iCurrentOrigin)=0
Sets Machining Direction current origin.
Parameters:
iCurrentOrigin
The current origin
o SetDirection
public virtual HRESULT SetDirection( const CATMathDirection& iDirection,
int iNotify=1)=0
Sets the direction of the Machining Direction Object.
Parameters:
iDirection
The mathematic direction
iNotify
The notification
o SetFlagModif
public virtual HRESULT SetFlagModif( const int& iFlag)=0
Sets the modification flag of the Machining Direction Object.
Parameters:
iFlag
The flag
o SetMode
public virtual HRESULT SetMode( const CATUnicodeString& iString)=0
Sets the definition mode of the Machining Direction Object.
Parameters:
String
The mode
o SetOrigin
public virtual HRESULT SetOrigin( const CATMathPoint& iPoint)=0
Sets Machining Direction origin.
Parameters:
iPoint
The mathematical point
o SetOriginMode
public virtual HRESULT SetOriginMode( const int& iMode)=0
Sets Machining Direction origin mode.
Parameters:
iMode
The mode
o SetSelectedGeometry
public virtual HRESULT SetSelectedGeometry( const CATBaseUnknown_var& iElement,
const CATBaseUnknown_var& iProduct=NULL_var)=0
Sets the geometry associated to the Machining Direction Object.
Parameters:
iElement
The geometric element
iProduct
The belonging product
o SetSelectionMode2Rotations
public virtual HRESULT SetSelectionMode2Rotations( const int iMode)=0
Sets selection mode to Two Rotations.
Parameters:
iMode
The mode
o SetSelectionModeAxis
public virtual HRESULT SetSelectionModeAxis( const int iMode)=0
Sets semection mode to Axis.
Parameters:
iMode
The mode
o SetSelectionModeManual
public virtual HRESULT SetSelectionModeManual( const int iMode)=0
Sets selection mode to Manual.
Parameters:
iMode
The mode
o SetSelectionModeNormalBottom
public virtual HRESULT SetSelectionModeNormalBottom( const int iMode)=0
Sets the selection mode to Normal To Bottom.
Parameters:
iMode
The mode
o SetSelectionModeNormalView
public virtual HRESULT SetSelectionModeNormalView( const int iMode)=0
Sets the selection mode to Normal To View.
Parameters:
iMode
The mode
o SetSelectionModePtView
public virtual HRESULT SetSelectionModePtView( const int iMode)=0
Sets seleciton mode to Point In the View.
Parameters:
iMode
The mode
o SetSelectionModeSelection
public virtual HRESULT SetSelectionModeSelection( const int iMode)=0
Sets the selection mode to Selection.
Parameters:
iMode
The mode
o SetTransformation
public virtual HRESULT SetTransformation(CATMathTransformation iTransformation)=0
Sets Machining Direction transformation matrix.
Parameters:
iTransformation
The transformation
o SetVector
public virtual HRESULT SetVector( const CATMathDirection& iDirection)=0
Sets Machining Direction Vector.
Parameters:
iDirection
The vector
o SetVisuTransformation
public virtual HRESULT SetVisuTransformation(CATMathTransformation iTransForAxis,
CATMathTransformation iTransForOrigin)=0
Sets the visualization transformation of the Machining Direction object.
Parameters:
iTransForAxis
The transformation for the axis
oTransForOrigin
The transofrmation for the origin

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

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