All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisResources Class CATSamBasicComponentManagerAdaptor

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATAnalysisInterfaces.CATISamBasicComponentManager
        |
        +---CATSamBasicComponentManagerAdaptor
 

Usage: you can derive this class.


public class CATSamBasicComponentManagerAdaptor

Adapter for the implementation of CATISamBasicComponentManager interface.
It can be used for AnalysisEntity or AnalysisSet

See also:
CATISamBasicComponentManager


Constructor and Destructor Index


o CATSamBasicComponentManagerAdaptor()
Default constructor.
o ~CATSamBasicComponentManagerAdaptor()
Destructor.

Method Index


o GetNbOptionalBC(int&)
Returns the number of optional Basic Components.
o GetOptionalBCList(CATListValCATUnicodeString&,CATListValCATUnicodeString&,CATLISTV(CATBaseUnknown_var)&)
Returns the identifiers of the optional basic components.
o IsBasicComponentHidden(CATISamBasicComponent*)
Returns if the Basic Component frame is hidden.
o IsBasicComponentReadOnly(CATISamBasicComponent*)
Returns if the Basic Component frame is ReadOnly.
o IsBasicComponentRecordable(CATISamBasicComponent*)
Returns if the Basic Component participates to the Macros recording.

Constructor and Destructor


o CATSamBasicComponentManagerAdaptor
public CATSamBasicComponentManagerAdaptor()
Default constructor.
o ~CATSamBasicComponentManagerAdaptor
public virtual ~CATSamBasicComponentManagerAdaptor()
Destructor.

Methods


o GetNbOptionalBC
public virtual HRESULT GetNbOptionalBC(int& NbOptionalBC)
Returns the number of optional Basic Components.
Parameters:
NbOptionalBC
: the number of optional Basic Components.
o GetOptionalBCList
public virtual HRESULT GetOptionalBCList(CATListValCATUnicodeString& oBCNameList,
CATListValCATUnicodeString& oLiteralNameList,
CATLISTV(CATBaseUnknown_var)& oListOfCATICkeType)
Returns the identifiers of the optional basic components.
Parameters:
oBCNameList
: List of Basic Components name, this is name of instance.
oBCTypeList
: List of Basic Components name, this is name of startup.
oListOfCATICkeType
: Used only in the case of Literal features. CATICkeType of the literal to derive.
For Example, use static CATICkeType_var MyLength = CATIParmDictionary::LengthType to create a length dimension.
See also:
CATIParmDictionary
o IsBasicComponentHidden
public virtual SAMHiddenState IsBasicComponentHidden( const CATISamBasicComponent* iBasicComponent)
Returns if the Basic Component frame is hidden.
Parameters:
iBasicComponent
: the basic component
Returns:
SAMHiddenState
See also:
SAMHiddenState
o IsBasicComponentReadOnly
public virtual SAMReadOnlyState IsBasicComponentReadOnly( const CATISamBasicComponent* iBasicComponent)
Returns if the Basic Component frame is ReadOnly.
Parameters:
iBasicComponent
: the basic component
Returns:
SAMReadOnlyState
See also:
SAMReadOnlyState
o IsBasicComponentRecordable
public virtual CATBoolean IsBasicComponentRecordable( const CATISamBasicComponent* iBasicCompoment)
Returns if the Basic Component participates to the Macros recording. The hypothesis is that your entity or set is managed by CATSamCreateEntityCmd.
Parameters:
iBasicComponent
: the basic component
Returns:
  • TRUE if the basic component is recorded. This is the default.
  • FALSE if the basic component is hidden.

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

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