All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

StructureInterfaces Interface CATIStructureObject

System.IUnknown
  |
  +---CATIStructureObject
 

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


interface CATIStructureObject

Interface to manage the structure object information.
Role: To retrieve data from a structure object such as attributes and materials.


Method Index


o GetAttribute(CATUnicodeString&,CATICkeParm**)
Get the structure object attribute value.
o GetMaterial(CATIMaterialFeature**)
Get the material of a structure object.
o ListAttributeName(CATListValCATUnicodeString**)
Get the list attribute names of a structure object.
o SetMaterial(CATIMaterialFeature*)
Set the material of a structure object.

Methods


o GetAttribute
public virtual HRESULT GetAttribute(CATUnicodeString& ipName,
CATICkeParm** opParm)=0
Get the structure object attribute value.
Parameters:
CATUnicodeString
Input the structure object attribute name.
CATICkeParm
[out, CATICkeParm#Release] Returns the parameter defining structure object attribute value.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o GetMaterial
public virtual HRESULT GetMaterial(CATIMaterialFeature** oMaterial)=0
Get the material of a structure object.
Parameters:
CATIMaterialFeature
[out, CATIMaterialFeature#Release] Returns the parameter defining the structure object material.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o ListAttributeName
public virtual HRESULT ListAttributeName(CATListValCATUnicodeString** oListOfAttributeNames)=0
Get the list attribute names of a structure object.
Parameters:
CATListValCATUnicodeString
Returns the list of attribute names of a structure object.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
o SetMaterial
public virtual HRESULT SetMaterial( const CATIMaterialFeature* iMaterial)=0
Set the material of a structure object.
Parameters:
CATIMaterialFeature
[in, CATIMaterialFeature#Release] Specifies parameter defining the structure object material.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed

This object is included in the file: CATIStructureObject.h

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