All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamCheckDesignTable

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

Usage: you can freely reimplement this interface.


interface CATISamCheckDesignTable

Complete the definition of the SAMDesignTablePtr basic component.
The SAMDesignTablePtr is used in order to manage the storage of some data inside design table files. This interface allows to add some controle on the content of this file. It can be complemented on the entity that aggregate the component or directely on the component.


Method Index


o CheckFormat(CATISamBasicComponent*,CATIDesignTable*,CATListOfCATUnicodeString&)
Controles the file format.
o GetColTitles(CATISamBasicComponent*,CATListOfCATUnicodeString&)
Returns the title of the column(s).
o GetMagnitudes(CATISamBasicComponent*,CATListOfCATUnicodeString&)
Returns the list of mangitude.
o GetNbColumns(CATISamBasicComponent*,int&)
Returns the number of column.
o IsBoundingBoxDisplayed(CATISamBasicComponent*,int&)
Adds a bounfing box option.

Methods


o CheckFormat
public virtual HRESULT CheckFormat( const CATISamBasicComponent* ipiBasicComponent,
CATIDesignTable* iDT,
CATListOfCATUnicodeString& oUnits) =0
Controles the file format.
Parameters:
ipiBasicComponent
: basic component.
ipiDT
:The design table file.
oUnits
: The Units list.
o GetColTitles
public virtual HRESULT GetColTitles( const CATISamBasicComponent* ipiBasicComponent,
CATListOfCATUnicodeString& oTitles) =0
Returns the title of the column(s).
Parameters:
ipiBasicComponent
: basic component.
oTitles
: Number of columns
o GetMagnitudes
public virtual HRESULT GetMagnitudes( const CATISamBasicComponent* ipiBasicComponent,
CATListOfCATUnicodeString& oMagnitudes) =0
Returns the list of mangitude.
Parameters:
ipiBasicComponent
: basic component.
oMagnitudes
: The magnitude list.
o GetNbColumns
public virtual HRESULT GetNbColumns( const CATISamBasicComponent* ipiBasicComponent,
int& oNb) =0
Returns the number of column.
Parameters:
ipiBasicComponent
: basic component.
oNb
: Number of columns
o IsBoundingBoxDisplayed
public virtual HRESULT IsBoundingBoxDisplayed( const CATISamBasicComponent* ipiBasicComponent,
int& oIsBoundingBoxDisp) = 0
Adds a bounfing box option. This make sense only if the design table returns a spatial way of assigning the values.
Parameters:
ipiBasicComponent
: basic component which the bounding box belongs to
oIsBoundingBoxDisp
: Controls of the check button. Legal Values:
  • 0: No check button is available.
  • 1
  • The check button is available.

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

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