All Frameworks Class Hierarchy This Framework Indexes Previous Next

PLMInterferenceUseItf Interface PLMIInterferenceResult

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

interface PLMIInterferenceResult

Interface to retrieve interference results of an Interference Simulation.

Use method to retrieve the list of interference results. Each element of this list is a pointer on interface PLMIInterferenceResult.

Method Index

o GetAnalysisStatus(PLMIInterferenceResult::ResultStatus&): Returns the status defined by user to interference.
o GetFirstProduct(CATIPLMNavOccurrence*&): Retrieves the first product in interference.
o GetGeometricalValues(CATMathPoint&,CATMathPoint&,double&): Retrieves the Geomtrical Values for an interference.
o GetResultType(PLMIInterferenceResult::ResultType&): Retrieves the type of result.
o GetSecondProduct(CATIPLMNavOccurrence*&): Retrieves the second product in interference.
o GetUserComment(CATUnicodeString&): Returns the comment defined by user to interference.
o GetUserType(PLMIInterferenceResult::ResultUserType&): Returns the type defined by user to interference.
o SetAnalysisStatus(PLMIInterferenceResult::ResultStatus): Sets the status defined by user to interference.
o SetUserComment(CATUnicodeString&): Sets a comment defined by user to interference.
o SetUserType(PLMIInterferenceResult::ResultUserType): Sets the type defined by user to interference.

o ResultStatus: Interference Status.
o ResultType: Interference Result Type.
o ResultUserType: Interference User Type.

Methods

o GetAnalysisStatus

public virtual GetAnalysisStatus( oStatus)

Returns the status defined by user to interference.

Parameters:

oStatus

[out] The status defined by

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

   This example gets the status of an interference of the current interference simulation.
      PLMIInterferenceSimulation   * piItfSimu  = ... ;  // (created by PLMIInterferenceServices)
   PLMIInterferenceResult       * piResult   = ... ;  //  one interference of the simulation (see method GetInterferenceResults of PLMIInterferenceSimulation)
   PLMIInterferenceResult::ResultStatus  Status = PLMIInterferenceResult::ResultStatusNotAnalyzed ;
   
   HRESULT hr = piResult->GetAnalysisStatus (Status) ;

o GetFirstProduct

public virtual GetFirstProduct( oProduct)

Retrieves the first product in interference.

Parameters:

oProduct: [out, CATBaseUnknown#Release] First product in interference.

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

   This example gets the first product in interference for an interference of the current interference simulation.
      PLMIInterferenceSimulation   * piItfSimu  = ... ;  // (created by PLMIInterferenceServices)
   PLMIInterferenceResult       * piResult   = ... ;  //  one interference of the simulation (see method GetInterferenceResults of PLMIInterferenceSimulation)
   CATIPLMNavOccurrence         * piOcc      = NULL ;
   
   HRESULT hr = piResult->GetFirstProduct (piOcc) ;

o GetGeometricalValues

public virtual GetGeometricalValues(		`oPoint1`,
		`oPoint2`,
		`oDistance`)

Retrieves the Geomtrical Values for an interference.
Retrieve the minimal distance and points for clearance and contact and clash.
In case of clash the point and distance value correspond to the penetration vector.
Distance and coordinates of points are given in millimeter.

Parameters:

oPoint1: [out] First point for the minimum distance or penetration vector.
oPoint2: [out] Second point for the minimum distance or penetration vector.
oDistance: [out] Minimum distance or penetration vector.

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

   This example gets the geometrical values of an interference of the current interference simulation.
      PLMIInterferenceSimulation   * piItfSimu  = ... ;  // (created by PLMIInterferenceServices)
   PLMIInterferenceResult       * piResult   = ... ;  //  one interference of the simulation (see method GetInterferenceResults of PLMIInterferenceSimulation)
   CATMathPoint   Pt1, Pt2 ;
   double   DistMin = 0.0 ;
   
   HRESULT hr = piResult->GetGeometricalValues (Pt1, Pt2, DistMin) ;

o GetResultType

public virtual GetResultType( oResultType)

Retrieves the type of result.

Parameters:

oResultType

[out] The type of result of an interference defined by

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

   This example gets the type of result of an interference of the current interference simulation.
      PLMIInterferenceSimulation   * piItfSimu  = ... ;  // (created by PLMIInterferenceServices)
   PLMIInterferenceResult       * piResult   = ... ;  //  one interference of the simulation (see method GetInterferenceResults of PLMIInterferenceSimulation)
   PLMIInterferenceResult::ResultType  ResultType = PLMIInterferenceResult::ResultTypeUndefined ;
   
   HRESULT hr = piResult->GetResultType (ResultType) ;

o GetSecondProduct

public virtual GetSecondProduct( oProduct)

Retrieves the second product in interference.

Parameters:

oProduct: [out, CATBaseUnknown#Release] Second product in interference.

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

   This example gets the second product in interference for an interference of the current interference simulation.
      PLMIInterferenceSimulation   * piItfSimu  = ... ;  // (created by PLMIInterferenceServices)
   PLMIInterferenceResult       * piResult   = ... ;  //  one interference of the simulation (see method GetInterferenceResults of PLMIInterferenceSimulation)
   CATIPLMNavOccurrence         * piOcc      = NULL ;
   
   HRESULT hr = piResult->GetFirstProduct (piOcc) ;

o GetUserComment

public virtual GetUserComment( oComment)

Returns the comment defined by user to interference.

Parameters:

oComment: [out] The comment.

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

   This example gets the comment of an interference of the current interference simulation.
      PLMIInterferenceSimulation   * piItfSimu  = ... ;  // (created by PLMIInterferenceServices)
   PLMIInterferenceResult       * piResult   = ... ;  //  one interference of the simulation (see method GetInterferenceResults of PLMIInterferenceSimulation)
   CATUnicodeString   Comment = "" ;
   
   HRESULT hr = piResult->GetUserComment (Comment) ;

o GetUserType

public virtual GetUserType( oUserType)

Returns the type defined by user to interference.

Parameters:

oUserType

[out] The user type defined by

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

   This example gets the user type of an interference of the current interference simulation.
      PLMIInterferenceSimulation   * piItfSimu  = ... ;  // (created by PLMIInterferenceServices)
   PLMIInterferenceResult       * piResult   = ... ;  //  one interference of the simulation (see method GetInterferenceResults of PLMIInterferenceSimulation)
   PLMIInterferenceResult::ResultUserType  UserType = PLMIInterferenceResult::ResultUserTypeClash ;
   
   HRESULT hr = piResult->GetUserType (UserType) ;

o SetAnalysisStatus

public virtual SetAnalysisStatus( iStatus)

Sets the status defined by user to interference.

Parameters:

iStatus

[in] The status defined by

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

   This example sets the status "OK" to an interference of the current interference simulation.
      PLMIInterferenceSimulation   * piItfSimu  = ... ;  // (created by PLMIInterferenceServices)
   PLMIInterferenceResult       * piResult   = ... ;  //  one interference of the simulation (see method GetInterferenceResults of PLMIInterferenceSimulation)
   PLMIInterferenceResult::ResultStatus  Status = PLMIInterferenceResult::ResultStatusOK ;
   
   HRESULT hr = piResult->SetAnalysisStatus (Status) ;

o SetUserComment

public virtual SetUserComment( iComment)

Sets a comment defined by user to interference.

Parameters:

iComment

[in] The comment.
Legal values:

Any character string: The interference has this string as comment.

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

   This example sets the comment "No comment" to an interference of the current interference simulation.
      PLMIInterferenceSimulation   * piItfSimu  = ... ;  // (created by PLMIInterferenceServices)
   PLMIInterferenceResult       * piResult   = ... ;  //  one interference of the simulation (see method GetInterferenceResults of PLMIInterferenceSimulation)
   CATUnicodeString   Comment = "No comment" ;
   
   HRESULT hr = piResult->SetUserComment (Comment) ;

o SetUserType

public virtual SetUserType( iUserType)

Sets the type defined by user to interference.

Parameters:

iUserType

[in] The user type defined by

Returns:

S_OK: If the operation is successful.
E_FAIL: If the operation is failed.

Example:

   This example sets the user type "Clash" of an interference of the current interference simulation.
      PLMIInterferenceSimulation   * piItfSimu  = ... ;  // (created by PLMIInterferenceServices)
   PLMIInterferenceResult       * piResult   = ... ;  //  one interference of the simulation (see method GetInterferenceResults of PLMIInterferenceSimulation)
   PLMIInterferenceResult::ResultUserType  UserType = PLMIInterferenceResult::ResultUserTypeClash ;
   
   HRESULT hr = piResult->SetUserType (UserType) ;

Enumerated Types

o ResultStatus

enum ResultStatus {
  ResultStatusOK,
  ResultStatusKO,
  ResultStatusNotAnalyzed
}

Interference Status.
The interference status may be categorized by user with followings types:

Parameters:

ResultStatusOK,: The result is OK.
ResultStatusKO,: The result is KO.
ResultStatusNotAnalyzed,: The result is not analyzed.

o ResultType

enum ResultType {
  ResultTypeClash,
  ResultTypeContact,
  ResultTypeClearance,
  ResultTypeNoInterference,
  ResultTypeUndefined
}

Interference Result Type.
The type of result may have followings values :

Parameters:

ResultTypeClash: Clash
ResultTypeContact: Contact
ResultTypeClearance: Clearance
ResultTypeNoInterference: No interference
ResultTypeUndefined: Undefined

o ResultUserType

enum ResultUserType {
  ResultUserTypeClash,
  ResultUserTypeContact,
  ResultUserTypeClearance,
  ResultUserTypeNoInterference,
  ResultUserTypeUndefined
}

Interference User Type.
The interference result may be categorized by user with followings types:

Parameters:

ResultUserTypeClash,: The result is clash.
ResultUserTypeContact,: The result is contact.
ResultUserTypeClearance,: The result is a clearance violation.
ResultUserTypeNoInterference,: The result is not an interference.
ResultUserTypeUndefined,: The result is not categorized.

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

PLMInterferenceUseItf Interface PLMIInterferenceResult

Method Index

Enumerated Type Index

Methods

Enumerated Types