All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

System Class CATBaseObject

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

Usage: you can derive this class.


public class CATBaseObject

Adaptor class for the CATIABase Interface.
Role: This class provides a default implementation for the CATIABase interface. All implementations of Automation interfaces being derived from CATIABase should inherit from CATBaseObject.

See also:
CATIABase


Constructor and Destructor Index


o CATBaseObject()
Default constructor.
o CATBaseObject(CATBaseDispatch*)
Constructs a CATBaseObject with the given parent.

Method Index


o GetItem(CATBSTR&,CATBaseDispatch*&)
Retrieves an object with the specified name.
o get_Application(CATIAApplication*&)
Returns the application.
o get_Name(CATBSTR&)
Returns the name of the object.
o get_Parent(CATBaseDispatch*&)
Returns the parent of the object.
o put_Name(CATBSTR&)
Sets the name of the object.

Data Member Index


o _name
The name of the object.
o _parent
The stored parent.

Constructor and Destructor


o CATBaseObject
public CATBaseObject()
Default constructor.
o CATBaseObject
public CATBaseObject(CATBaseDispatch* iParent)
Constructs a CATBaseObject with the given parent.
Parameters:
iParent
The parent of the CATBaseObject

Methods


o GetItem
public virtual HRESULT GetItem( const CATBSTR& iNameBSTR,
CATBaseDispatch*& oObject)
Retrieves an object with the specified name. See CATIABase.GetItem for a complete description of this method. All implementations must override this default implementation.
Parameters:
iNameBSTR
The specified name of the object to retrieve
oObject
The returned object
o get_Application
public virtual HRESULT get_Application(CATIAApplication*& oApplication)
Returns the application. See CATIABase.get_Application for a complete description of this method.
Parameters:
oApplication
The returned application
o get_Name
public virtual HRESULT get_Name(CATBSTR& oNameBSTR)
Returns the name of the object. See CATIABase.get_Name for a complete description of this method. All implementations must override this default implementation.
Parameters:
oNameBSTR
The returned name
o get_Parent
public virtual HRESULT __stdcall get_Parent(CATBaseDispatch*& oParent)
Returns the parent of the object. See CATIABase.get_Parent for a complete description of this method. All implementations must override this default implementation.
Parameters:
oParent
The returned parent
o put_Name
public virtual HRESULT put_Name( const CATBSTR& iNameBSTR)
Sets the name of the object. See CATIABase.put_Name for a complete description of this method. All implementations must override this default implementation.
Parameters:
iNameBSTR
The name to set

Data Members


o _name
  protected CATUnicodeString _name
The name of the object.
o _parent
  protected CATBaseDispatch *_parent
The stored parent.

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

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