All Frameworks Class Hierarchy This Framework Indexes Previous Next

System Interface CATIACollection

Usage: you cannot implement this base interface directly. You must first derive it and then implement the derived interface.

interface CATIACollection

Represents the base object for collections.
As a base object, it provides properties shared by any other object. Use the adaptor class to implement this interface.

Method Index

o GetItem(CATBSTR&,CATBaseDispatch*&): Retrieves an object with the specified name.
o get_Application(CATIAApplication*&): Returns the application.
o get_Count(CATLONG&): Returns the number of objects in the collection.
o get_Name(CATBSTR&): Returns the name of the collection.
o get_Parent(CATBaseDispatch*&): Returns the parent object.
o get__NewEnum(IUnknown*&): Returns an iterator on the collection.

Methods

o GetItem

public virtual GetItem(	const	`iIDName`,
		`oObject`)

Retrieves an object with the specified name.

Parameters:

iIDName: The specified name of the object to retrieve
oObject: The returned object

o get_Application

public virtual get_Application( oApplication)

Returns the application.
Role: The application is the root object of the object structure and can be retrieved from any object in this object structure.

Parameters:

oApplication: The returned application

o get_Count

public virtual get_Count( oNbItems)

Returns the number of objects in the collection.

Parameters:

oNbItems: The returned count

o get_Name

public virtual get_Name( oName)

Returns the name of the collection.

Parameters:

oName: The returned name

o get_Parent

public virtual get_Parent( oParent)

Returns the parent object.
Role: The parent object of a given object is the object just above in the object structure, usually the object that created this object and that aggregates it.

Parameters:

oParent: The returned parent

o get__NewEnum

public virtual get__NewEnum( oEnumIter)

Returns an iterator on the collection.
Role: This method must be implemented to allow the caller to easily iterate through the collection in VB scripts with the For Each statement.

Parameters:

oEnumIter: The returned iterator

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