All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamBasicComponent

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

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


interface CATISamBasicComponent

Interface to basic compoment.
Role: Interface designed to manage Analysis Basic Components.

In the Analysis Model, a Basic Component is the low level descriptive data. It is a "brick" dedicated to build the Analysis Entitie .
An Analysis Entity describes a Physical data (loads, restraints, materials, etc.) whereas a Basic Components may not have a physical meaning on their own.
A Basic Components can contain several Blocks. A Block is identified by a label. It contains entity data of the same type, organized in superimposed tables.


Method Index


o AddSubComponent(CATISamBasicComponent_var&)
Adds a given sub component to the component.
o AddSubComponent(CATISpecObject_var&)
Adds a given sub component to the component.
o AddSubComponent(CATUnicodeString&,CATUnicodeString&,CATBaseUnknown_var&)
Adds a given sub component to the component.
o GetBaseUnknownValue(CATBaseUnknown_var&,CATUnicodeString&,int,int,int)
Retreives the value of the Component.
o GetBooleanValue(CATBoolean&,CATUnicodeString&,int,int,int)
Retreives the value of the Component.
o GetDefinedEntity(CATBaseUnknown_var&)
Return the entity which uses the basic component in its definition.
o GetDescriptiveProperty(CATUnicodeString&)
Retrieves a descriptive property about the Basic Component.
o GetDimensions(CATLONG32&,CATLONG32&,CATLONG32&,CATUnicodeString&)
Retrieves the dimensions of the Basic Component structure.
o GetDoubleValue(double&,CATUnicodeString&,int,int,int)
Retreives the value of the Component.
o GetIntegerValue(int&,CATUnicodeString&,int,int,int)
Retreives the value of the Component.
o GetLinkableValue(CATILinkableObject_var&,CATILinkableObject_var&,CATUnicodeString&,int,int,int)
Retreives the value of the Component.
o GetName(CATUnicodeString&)
Retrieves the name of the Basic Component.
o GetOctetValue(octet&,CATUnicodeString&,int,int,int)
Retreives the value of the Component.
o GetStringValue(CATUnicodeString&,CATUnicodeString&,int,int,int)
Retreives the value of the Component.
o GetSubComponent(CATUnicodeString&,CATISamBasicComponent_var&)
Retrieves a subcomponent with a the given name.
o GetSubComponent(CATUnicodeString&,CATISpecObject_var&)
Retrieves a subcomponent with a given name.
o GetSubComponents(CATLISTV(CATBaseUnknown_var)*&,CATUnicodeString&)
Retrieves the list of subcomponents.
o GetType(CATUnicodeString&)
Retrieves the type of the Basic Component.
o GetValueType(TCKind&,CATUnicodeString&)
Retrieves the type of the basic component value.
o Init()
Initializes the Basic Component.
o RemoveLayer(int)
Remove all intances of a layer.
o RemoveSubComponent(CATISamBasicComponent_var&)
Removes the given sub component from the component.
o RemoveSubComponent(CATISpecObject_var&)
Removes the given sub component from the component.
o SetBaseUnknownValue(CATBaseUnknown_var&,CATUnicodeString&,int,int,int)
Sets the value of the Component.
o SetBaseUnknownValue(CATUnicodeString&,CATUnicodeString&,CATBaseUnknown_var&,CATUnicodeString&,int,int,int)
Sets the value of the Component.
o SetBooleanValue(CATBoolean,CATUnicodeString&,int,int,int)
Sets the value of the Component.
o SetDimensions(CATLONG32,CATLONG32,CATLONG32)
Sets the dimensions of the Basic Component structure.
o SetDoubleValue(double,CATUnicodeString&,int,int,int)
Sets the value of the Component.
o SetIntegerValue(int,CATUnicodeString&,int,int,int)
Sets the value of the Component.
o SetLinkableValue(CATILinkableObject_var&,CATILinkableObject_var&,CATUnicodeString&,int,int,int)
Sets the value of the Component.
o SetName(CATUnicodeString&)
Sets the name of the Basic Component.
o SetOctetValue(octet,CATUnicodeString&,int,int,int)
Sets the value of the Component.
o SetStringValue(CATUnicodeString&,CATUnicodeString&,int,int,int)
Sets the value of the Component.

Methods


o AddSubComponent
public virtual HRESULT AddSubComponent( const CATISamBasicComponent_var& iComponent) = 0
Adds a given sub component to the component.
Only for basic components dedicated to encapsulate other components.
Parameters:
iComponent
the agregated component.
o AddSubComponent
public virtual HRESULT AddSubComponent( const CATISpecObject_var& iComponent) = 0
Adds a given sub component to the component.
Only for basic components dedicated to encapsulate other components.
Parameters:
iComponent
the agregated component.
o AddSubComponent
public virtual HRESULT AddSubComponent( const CATUnicodeString& iFeatureName,
const CATUnicodeString& iFeatureType,
const CATBaseUnknown_var& iCkeType)=0
Adds a given sub component to the component.
Only for basic components dedicated to encapsulate other components.
Parameters:
iFeatureType
: features type
iCkeType
: type of the instance to create if Literal
o GetBaseUnknownValue
public virtual HRESULT GetBaseUnknownValue(CATBaseUnknown_var& oValue,
const CATUnicodeString& iLabel= NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0) const = 0
Retreives the value of the Component.
Parameters:
oValue
The returned value.
iLabel
the optional block label.
iLineIndex
the optional index of the target line.
iColumnIndex
the optional index of the target Column.
iLayerIndex
the optional index of the target Layer.
o GetBooleanValue
public virtual HRESULT GetBooleanValue(CATBoolean& oValue,
const CATUnicodeString& iLabel= NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0) const = 0
Retreives the value of the Component.
Parameters:
oValue
The returned value.
iLabel
the optional block label.
iLineIndex
the optional index of the target line.
iColumnIndex
the optional index of the target Column.
iLayerIndex
the optional index of the target Layer.
o GetDefinedEntity
public virtual HRESULT GetDefinedEntity(CATBaseUnknown_var& oEntity) const = 0
Return the entity which uses the basic component in its definition.
Parameters:
oEntity
the entity used.
o GetDescriptiveProperty
public virtual HRESULT GetDescriptiveProperty(CATUnicodeString& oProperty) const = 0
Retrieves a descriptive property about the Basic Component.
For instance, "AntisymetricStructure" for a Tensor.
Parameters:
oProperty
the Descriptive Property.
o GetDimensions
public virtual HRESULT GetDimensions(CATLONG32& oLinesNumber,
CATLONG32& oColumnsNumber,
CATLONG32& oLayersNumber,
const CATUnicodeString& iLabel= NULL) const = 0
Retrieves the dimensions of the Basic Component structure.
Parameters:
oLinesNumber
The number of lines.
oColumnsNumber
The number of Columns.
oLayersNumber
The number of Layers.
iLabel
The optional Block label.
o GetDoubleValue
public virtual HRESULT GetDoubleValue(double& oValue,
const CATUnicodeString& iLabel= NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0) const = 0
Retreives the value of the Component.
Parameters:
oValue
The returned value.
iLabel
the optional block label.
iLineIndex
the optional index of the target line.
iColumnIndex
the optional index of the target Column.
iLayerIndex
the optional index of the target Layer.
o GetIntegerValue
public virtual HRESULT GetIntegerValue(int& oValue,
const CATUnicodeString& iLabel= NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0) const = 0
Retreives the value of the Component.
Parameters:
oValue
The returned value.
iLabel
the optional block label.
iLineIndex
the optional index of the target line.
iColumnIndex
the optional index of the target Column.
iLayerIndex
the optional index of the target Layer.
iLayerIndex
Facultative Index of the target Layer.
o GetLinkableValue
public virtual HRESULT GetLinkableValue(CATILinkableObject_var& OValue,
CATILinkableObject_var& OProduct,
const CATUnicodeString& iLabel=NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0)=0
Retreives the value of the Component.
Parameters:
oValue
The new value.
oProduct
The product positionning the value.
oLabel
The optional Block label.
oLineIndex
The index of the target line.
oColumnIndex
The index of the target Column.
oLayerIndex
The index of the target Layer.
o GetName
public virtual HRESULT GetName(CATUnicodeString& oName) const = 0
Retrieves the name of the Basic Component.
Parameters:
oName
The Name of the Basic component.
o GetOctetValue
public virtual HRESULT GetOctetValue(octet& oValue,
const CATUnicodeString& iLabel= NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0) const = 0
Retreives the value of the Component.
Parameters:
oValue
The returned value.
iLabel
the optional block label.
iLineIndex
the optional index of the target line.
iColumnIndex
the optional index of the target Column.
iLayerIndex
the optional index of the target Layer.
o GetStringValue
public virtual HRESULT GetStringValue(CATUnicodeString& oValue,
const CATUnicodeString& iLabel= NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0) const = 0
Retreives the value of the Component.
Parameters:
oValue
The returned value.
iLabel
the optional block label.
iLineIndex
the optional index of the target line.
iColumnIndex
the optional index of the target Column.
iLayerIndex
the optional index of the target Layer.
o GetSubComponent
public virtual HRESULT GetSubComponent( const CATUnicodeString& iName,
CATISamBasicComponent_var& oComponent) const = 0
Retrieves a subcomponent with a the given name.
Only for components dedicated to encapsulate other components.
Parameters:
iName
the name of the searched component.
oComponent
the returned component.
o GetSubComponent
public virtual HRESULT GetSubComponent( const CATUnicodeString& iName,
CATISpecObject_var& oComponent) const = 0
Retrieves a subcomponent with a given name.
Only for components dedicated to encapsulate other components.
Parameters:
iName
the name of the searched component.
oComponent
the returned component.
o GetSubComponents
public virtual HRESULT GetSubComponents(CATLISTV(CATBaseUnknown_var)*& oComponents,
const CATUnicodeString& iType=NULL) const = 0
Retrieves the list of subcomponents.
Only for components dedicated to encapsulate other components.
Parameters:
oComponents
the list of subcomponents.
iType
The type of the basic component.
o GetType
public virtual HRESULT GetType(CATUnicodeString& oType) const = 0
Retrieves the type of the Basic Component.
Parameters:
oType
The type of the Basic component.
o GetValueType
public virtual HRESULT GetValueType(TCKind& oValueType,
const CATUnicodeString& iLabel= NULL) const = 0
Retrieves the type of the basic component value.
Parameters:
oValueType
The type of value.
iLabel
The facultative Block label.
o Init
public virtual HRESULT Init()= 0
Initializes the Basic Component. This Method is called after the Basic Component is created. Do not use.
o RemoveLayer
public virtual HRESULT RemoveLayer(int iLayerIndex) const=0
Remove all intances of a layer. Note: To use with StartUps and MultiLayerManager basic components
o RemoveSubComponent
public virtual HRESULT RemoveSubComponent( const CATISamBasicComponent_var& iComponent) = 0
Removes the given sub component from the component.
Only for components dedicated to encapsulate other components.
Parameters:
iComponent
the removed component.
o RemoveSubComponent
public virtual HRESULT RemoveSubComponent( const CATISpecObject_var& iComponent) = 0
Removes the given sub component from the component.
Only for components dedicated to encapsulate other components.
Parameters:
iComponent
the removed component.
o SetBaseUnknownValue
public virtual HRESULT SetBaseUnknownValue( const CATBaseUnknown_var& oValue,
const CATUnicodeString& iLabel= NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0) = 0
Sets the value of the Component.
Parameters:
iValue
The new value.
iLabel
The optional Block label.
iLineIndex
The index of the target line.
iColumnIndex
The index of the target Column.
iLayerIndex
The index of the target Layer.
o SetBaseUnknownValue
public virtual HRESULT SetBaseUnknownValue( const CATUnicodeString& iFeatureName,
const CATUnicodeString& iFeatureType,
const CATBaseUnknown_var& iCkeType,
const CATUnicodeString& iLabel= NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0) = 0
Sets the value of the Component.
Parameters:
iFeatureName
: features instance name
iFeatureType
: features type
iCkeType
: type of the instance to create if Literal
o SetBooleanValue
public virtual HRESULT SetBooleanValue(CATBoolean iValue,
const CATUnicodeString& iLabel= NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0) = 0
Sets the value of the Component.
Parameters:
iValue
The new value.
iLabel
The optional Block label.
iLineIndex
The index of the target line.
iColumnIndex
The index of the target Column.
iLayerIndex
The index of the target Layer.
o SetDimensions
public virtual HRESULT SetDimensions(CATLONG32 iLinesNumber,
CATLONG32 iColumnsNumber,
CATLONG32 iLayersNumber) const = 0
Sets the dimensions of the Basic Component structure. Note: To use with StartUps and MultiLayerManager basic components
Parameters:
iLinesNumber
The number of lines.
iColumnsNumber
The number of Columns.
iLayersNumber
The number of Layers.
o SetDoubleValue
public virtual HRESULT SetDoubleValue(double iValue,
const CATUnicodeString& iLabel= NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0) = 0
Sets the value of the Component.
Parameters:
iValue
The new value.
iLabel
The optional Block label.
iLineIndex
The index of the target line.
iColumnIndex
The index of the target Column.
iLayerIndex
The index of the target Layer.
o SetIntegerValue
public virtual HRESULT SetIntegerValue(int iValue,
const CATUnicodeString& iLabel= NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0) = 0
Sets the value of the Component.
Parameters:
iValue
The new value.
iLabel
The optional Block label.
iLineIndex
The index of the target line.
iColumnIndex
The index of the target Column.
iLayerIndex
The index of the target Layer.
o SetLinkableValue
public virtual HRESULT SetLinkableValue( const CATILinkableObject_var& iValue,
const CATILinkableObject_var& iProduct,
const CATUnicodeString& iLabel=NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0)=0
Sets the value of the Component.
Parameters:
iValue
The new value.
iProduct
The product positionning the value.
iLabel
The optional Block label.
iLineIndex
The index of the target line.
iColumnIndex
The index of the target Column.
iLayerIndex
The index of the target Layer.
o SetName
public virtual HRESULT SetName( const CATUnicodeString& iName) = 0
Sets the name of the Basic Component.
Parameters:
iName
The name of the Basic component.
o SetOctetValue
public virtual HRESULT SetOctetValue(octet iValue,
const CATUnicodeString& iLabel= NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0) = 0
Sets the value of the Component.
Parameters:
iValue
The new value.
iLabel
The optional Block label.
iLineIndex
The index of the target line.
iColumnIndex
The index of the target Column.
iLayerIndex
The index of the target Layer.
o SetStringValue
public virtual HRESULT SetStringValue( const CATUnicodeString& iValue,
const CATUnicodeString& iLabel= NULL,
int iLineIndex=0,
int iColumnIndex=0,
int iLayerIndex=0) = 0
Sets the value of the Component.
Parameters:
iValue
The new value.
iLabel
The optional Block label.
iLineIndex
The index of the target line.
iColumnIndex
The index of the target Column.
iLayerIndex
The index of the target Layer.

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

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