All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATStrUseItf Interface CATIStrUseCollarMngt

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

interface CATIStrUseCollarMngt

Interface to manage creation, deletion and retrieval of Collars on a Slot.
Role: Interface to manage Collars. Feature implementing this interface: SldSlot/SddOpening

Method Index

o AddCollar(CATIMmiMechanicalFeature_var&): Creates an empty Collar.
o GetCollars(CATLISTV(CATIMmiMechanicalFeature_var)&): Gets the Collars that are inside this object.
o RemoveCollar(CATIMmiMechanicalFeature_var&): Removes the specified Collar.

Methods

o AddCollar

public virtual AddCollar( ospCollar)

Creates an empty Collar. (@see CATIStrUseCollar)

Parameters:

ospCollar: The created Collar.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o GetCollars

public virtual GetCollars( oListOfCollars)

Gets the Collars that are inside this object. (@see CATIStrUseCollar)

Parameters:

oListOfCollars: List of Collars.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

o RemoveCollar

public virtual RemoveCollar( const ispCollar)

Removes the specified Collar.

Parameters:

ispCollar: The Collar object to be removed.

Returns:

HRESULT Return code of function. S_OK if everything ran ok. E_FAIL if something went wrong.

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