All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

StructureInterfaces Interface CATIStructurePlate

System.IUnknown
  |
  +---StructureInterfaces.CATIStructureObject
    |
    +---CATIStructurePlate
 

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


interface CATIStructurePlate

Interface to manage the plate information.
Role: To retrieve data from a plate such as plate attributes, materials, thickness and support.


Method Index


o Compute()
Compute.
o GetContour(CATISpecObject**)
Get the contour.
o GetExtrusionDirection(CATMathDirection&)
Get the extrusion direction.
o GetInternalOffset(double&)
Get internal offset of the plate.
o GetListOfVertices(CATListValCATMathPoint&)
Get the list of vertices.
o GetSupport(CATISpecObject**)
Get the support.
o GetThickness(double&)
Get thickness of the plate.
o ReverseDirection()
Reverse the extrusion direction.
o SetContour(CATISpecObject*)
Set the contour.
o SetInternalOffset(double&)
Set internal offset of the plate.
o SetSupport(CATISpecObject*)
Set the support.
o SetThickness(double&)
Set thickness of the plate.

Methods


o Compute
public virtual HRESULT Compute()=0
Compute. Compute the plate object.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetContour
public virtual HRESULT GetContour(CATISpecObject** opContour)=0
Get the contour.
Parameters:
opContour
Contour.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetExtrusionDirection
public virtual HRESULT GetExtrusionDirection(CATMathDirection& oExtrusionDirection)=0
Get the extrusion direction. It's a normal to the support oriented according to the extrusion direction.
Parameters:
oExtrusionDirection
Extrusion Direction.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetInternalOffset
public virtual HRESULT GetInternalOffset(double& oOffset)=0
Get internal offset of the plate.(in MKS) Offset is based on the support, opposite to the extrusion direction.
Parameters:
oOffset
Offset of the plate.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetListOfVertices
public virtual HRESULT GetListOfVertices(CATListValCATMathPoint& oListOfVertices)=0
Get the list of vertices.
Parameters:
oListOfVertices
List of vertices.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetSupport
public virtual HRESULT GetSupport(CATISpecObject** opSupport)=0
Get the support.
Parameters:
opSupport
Support.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetThickness
public virtual HRESULT GetThickness(double& oThickness)=0
Get thickness of the plate. (in MKS)
Parameters:
oThickness
Thickness of the plate.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ReverseDirection
public virtual HRESULT ReverseDirection()=0
Reverse the extrusion direction.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetContour
public virtual HRESULT SetContour( const CATISpecObject* ipContour)=0
Set the contour.
Parameters:
ipContour
Contour.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetInternalOffset
public virtual HRESULT SetInternalOffset( const double& iOffset)=0
Set internal offset of the plate. (in MKS) Offset is based on the support, opposite to the extrusion direction.
Parameters:
iOffset
Offset of the plate.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetSupport
public virtual HRESULT SetSupport( const CATISpecObject* ipSupport)=0
Set the support.
Parameters:
ipSupport
Support.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetThickness
public virtual HRESULT SetThickness( const double& iThickness)=0
Set thickness of the plate. (in MKS)
Parameters:
iThickness
Thickness of the plate.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIStructurePlate.h

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