All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

ElectricalInterfaces Interface CATIElecAttrAccess

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

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


interface CATIElecAttrAccess

Interface dedicated to attribute management.
Role: This interface helps you to retrieve and modifiy attributes.


Method Index


o Get(CATUnicodeString&,CATICkeInst_var&)
Retrieves the value of an attribute from its name.
o GetElecType(CATUnicodeString&)
Retrieve electrical type of entity.
o ListAttributeNames(CATListValCATUnicodeString*&)
Retrieves list of the attribute names.
o Set(CATUnicodeString&,CATBoolean)
Sets the value of an attribute (boolean).
o Set(CATUnicodeString&,CATICkeInst_var&)
Sets the value of an attribute.
o Set(CATUnicodeString&,CATUnicodeString&)
Sets the value of an attribute (string).
o Set(CATUnicodeString&,double)
Sets the value of an attribute (double in MKS).
o Set(CATUnicodeString&,int)
Sets the value of an attribute (integer).

Methods


o Get
public virtual HRESULT Get( const CATUnicodeString& iAttName,
CATICkeInst_var& oValue) = 0
Retrieves the value of an attribute from its name.
Parameters:
iAttName
the attribute name.
oValue
the attribute's value.
o GetElecType
public virtual HRESULT GetElecType(CATUnicodeString& oElecType)=0
Retrieve electrical type of entity.
Parameters:
oElecType
Type of entity.
o ListAttributeNames
public virtual HRESULT ListAttributeNames(CATListValCATUnicodeString*& oAttNameList) = 0
Retrieves list of the attribute names.
Parameters:
oAttNameList
the list of attribute names.
o Set
public virtual HRESULT Set( const CATUnicodeString& iAttName,
const CATBoolean iValue) = 0
Sets the value of an attribute (boolean).
Parameters:
iAttName
the attribute name.
iValue
the new value of the attribute.
o Set
public virtual HRESULT Set( const CATUnicodeString& iAttName,
const CATICkeInst_var& iValue) = 0
Sets the value of an attribute.
Parameters:
iAttName
the attribute name.
iValue
the new value of the attribute.
o Set
public virtual HRESULT Set( const CATUnicodeString& iAttName,
const CATUnicodeString& iValue) = 0
Sets the value of an attribute (string).
Parameters:
iAttName
the attribute name.
iValue
the new value of the attribute.
o Set
public virtual HRESULT Set( const CATUnicodeString& iAttName,
const double iValue) = 0
Sets the value of an attribute (double in MKS).
Parameters:
iAttName
the attribute name.
iValue
the new value of the attribute.
o Set
public virtual HRESULT Set( const CATUnicodeString& iAttName,
const int iValue) = 0
Sets the value of an attribute (integer).
Parameters:
iAttName
the attribute name.
iValue
the new value of the attribute.

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

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