All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATStrUseItf Interface CATIStrUseCategoryMngt

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

interface CATIStrUseCategoryMngt

Interface to manage the category and the naming of the functions Role: Interface to manage SFD/SDD functions category and naming.
Feature implementing this interface: SFD Functions(Plate and Profile), SFD Panel, Opening.

Method Index

o GetAutomaticName(CATBoolean&): Get the naming mode of this object: automatic or manual.
o GetCategory(CATUnicodeString&): Get the category of this object.
o GetName(CATUnicodeString&): Get the name of this object.
o SetAutomaticName(CATBoolean): Set the naming mode of this object: automatic or manual.
o SetCategory(CATUnicodeString&,CATBoolean): Set the category of this object.
o SetName(CATUnicodeString&): Set the name of this object.

Methods

o GetAutomaticName

public virtual GetAutomaticName( oMode)

Get the naming mode of this object: automatic or manual.

Parameters:

oMode: Current naming mode of the object. (TRUE = automatic, FALSE = manual)

o GetCategory

public virtual GetCategory( oCategory)

Get the category of this object.

Parameters:

oCategory: Current category of the object.

o GetName

public virtual GetName( oName)

Get the name of this object. This is equivalent to CATIAlias::GetAlias().

Parameters:

oName: Current name of the object.

o SetAutomaticName

public virtual SetAutomaticName( const iMode)

Set the naming mode of this object: automatic or manual. In the UI, the user can check the automatic mode and then the naming is generated from the category (see SetCategory). If the manual mode is selected, then the UI generate an alias according to the user entry. We store the mode in order not to regenerate the alias in case of the Copy/Paste for example and also so that the UI can remember at edition.

Parameters:

iMode: New naming mode of the object. (TRUE = automatic, FALSE = manual)

o SetCategory

public virtual SetCategory(	const	`iCategory`,
	const	`iForceValue`	`= CATFalse`)

Set the category of this object. This method will add a feature extension on this object and apply a specific alias to this object. There is no sequence number so far so the rule to generate the naming is to replace the current feature alias until ".##" by the alias (see CATStrFunctionalDesignNLS.CATNls) corresponding to the category. In V6, so far we have no sequence number available that is why we keep the number present in the display name of the feature.

Parameters:

iCategory: New category of the object.
iForceValue: Force the category to be set even if the previous one is the same.

o SetName

public virtual SetName( const iName)

Set the name of this object. This is equivalent to CATIAlias::SetAlias().

Parameters:

iName: New name of the object.

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