All Frameworks Class Hierarchy This Framework Previous Next Indexes
ComponentsCatalogsInterfaces Interface CATICatalogChapter
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICatalogChapter
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICatalogChapter
Interface to manage catalog chapters.
Role: A chapter is an object which contains :
A Chapter is created by the
CATICatalogChapterFactory.CreateChapter method. There are two kinds of chapters which depends on the second parameter of this CreateChapter method:
- Chapter which contains other sub-chapters
- Chapter which contains only components (feature,document,..). In this case, the chapter
is also named a family.
Method Index
- o
AddDescription(CATICatalogDescription*&,CATILinkableObject*)
- Adds a new description on the chapter.
- o
AddFamilyDescriptionsFromDesignTable(CATIDesignTable*)
- Adds a family of descriptions from a design table associated to a CATPart document.
- o
AddKeyword(CATUnicodeString&,CATICkeType*,CATICatalogKeyword*&)
- Creates a new keyword on the chapter.
- o
AddKeyword(CATUnicodeString&,CATUnicodeString&,CATICatalogKeyword*&)
- Creates a new keyword on the chapter.
- o
AddPersistentQuery(CATUnicodeString&,CATICatalogPersistentQuery*&)
- Adds a new persistent query on the chapter.
- o
FindKeyword(CATUnicodeString&,CATICatalogKeyword*&)
- Retrieves a keyword from its name.
- o
GetChapterName()
- Returns the name of the chapter.
- o
GetDefaultValue(CATUnicodeString&,CATBoolean&)
- Retrieves the default value of a boolean type keyword.
- o
GetDefaultValue(CATUnicodeString&,CATUnicodeString&)
- Retrieves the default value of a string type keyword.
- o
GetDefaultValue(CATUnicodeString&,double&)
- Retrieves the default value of a real type keyword.
- o
GetDefaultValue(CATUnicodeString&,int&)
- Retrieves the default value of an integer type keyword.
- o
GetNumberOfDescriptions(int&)
- Retrieves the number of descriptions on the chapter.
- o
HeritageOfKeywords(CATICatalogChapter_var&,CATListValCATICatalogKeyword_var*)
- Duplicates the Keywords on a chapter.
- o
KindIsEndChapter()
- Returns the type of the chapter.
- o
ListDescriptions(CATListValCATICatalogDescription_var*&)
- Retrieves all descriptions on the chapter.
- o
ListKeywords(CATListValCATICatalogKeyword_var*&)
- Retrieves the list of keywords on the chapter.
- o
ListPersistentQuery(CATListValCATICatalogPersistentQuery_var*&)
- Retrieves the list of persistents queries on the chapter.
- o
RemoveDescription(CATICatalogDescription*)
- Removes a description on the chapter.
- o
RemoveKeyword(CATICatalogKeyword*)
- Removes a keyword on the chapter.
- o
RemovePersistentQuery(CATICatalogPersistentQuery*,int)
- Removes a persistent query on the chapter.
- o
RenameKeyword(CATICatalogKeyword&,CATUnicodeString&)
- Renames one of the keywords of the chapter.
- o
SetDefaultValue(CATUnicodeString&,CATBoolean)
- Sets a default value of a boolean type keyword.
- o
SetDefaultValue(CATUnicodeString&,CATUnicodeString&)
- Sets a default value of a string type keyword.
- o
SetDefaultValue(CATUnicodeString&,double)
- Sets a default value of a real type keyword.
- o
SetDefaultValue(CATUnicodeString&,int)
- Sets a default value of an integer type keyword.
- o
UnsetDefaultValue(CATUnicodeString&)
- Removes the default value for a keyword.
Methods
o AddDescription
-
Adds a new description on the chapter.
- Parameters:
-
- oDescription
- [out, CATBaseUnknown#Release] The new description which has been created.
- iextObj
- The object to link to the new description. This object could be a chapter.
o AddFamilyDescriptionsFromDesignTable
-
Adds a family of descriptions from a design table associated to a CATPart document.
Role:This methods creates a set of descriptions on the current chapter
in taken account of each row of a design table. This chapter must be a family, in
other words a end chapter. See the
CATICatalogChapterFactory.CreateChapter method.
The design table must contains the "PartNumber" header.
This method creates automatically on the family a keyword for each header of
the design table. The value of each keyword on each description is the value
taken in the design table.
- Parameters:
-
- iDT
- The design table which has been retrieve from the CATPart document.
o AddKeyword
-
Creates a new keyword on the chapter.
- Parameters:
-
- iName
- The name of the keyword to create.
- iType
- The type of the keyword to create.
- oNewKeyword
- [out, CATBaseUnknown#Release] The new keyword.
o AddKeyword
-
Creates a new keyword on the chapter.
- Parameters:
-
- iName
- The name of the keyword to create.
- iType
- The type of the keyword to create.
Example: string, LENGTH, REAL.
- oNewKeyword
- [out, CATBaseUnknown#Release] The new keyword.
o AddPersistentQuery
-
Adds a new persistent query on the chapter.
- Parameters:
-
- iQueryName
- The name of the query.
- oPersistentQuery
- [out, CATBaseUnknown#Release] The new persistent query.
o FindKeyword
-
Retrieves a keyword from its name.
- Parameters:
-
- iName
- The name of the keyword to retrieve.
- oKeyword
- [out, CATBaseUnknown#Release] The keyword.
o GetChapterName
-
Returns the name of the chapter.
- Returns:
- The name of the chapter.
o GetDefaultValue
-
Retrieves the default value of a boolean type keyword.
- Parameters:
-
- iName
- The name of the keyword.
- odefaultValue
- The default value (boolean).
o GetDefaultValue
-
Retrieves the default value of a string type keyword.
- Parameters:
-
- iName
- The name of the keyword.
- odefaultValue
- The default value (string).
o GetDefaultValue
-
Retrieves the default value of a real type keyword.
- Parameters:
-
- iName
- The name of the keyword.
- odefaultValue
- The default value (real).
o GetDefaultValue
-
Retrieves the default value of an integer type keyword.
- Parameters:
-
- iName
- The name of the keyword.
- odefaultValue
- The default value (integer).
o GetNumberOfDescriptions
public virtual HRESULT GetNumberOfDescriptions( | int& | oNumberOfDescriptions) = 0 |
-
Retrieves the number of descriptions on the chapter.
- Parameters:
-
- oNumberOfDescriptions
- The number of descriptions.
o HeritageOfKeywords
public virtual HRESULT HeritageOfKeywords( | const CATICatalogChapter_var& | iFatherChapter, |
| const CATListValCATICatalogKeyword_var* | LstKeywords | =NULL )= 0 |
-
Duplicates the Keywords on a chapter.
- Parameters:
-
- iFatherChapter
- The chaper from which the keyword are coped, this paramater is not taken
into account if LstKeyword is valuated
- LstKeywords
- The list of keyword to dupilcate
o KindIsEndChapter
-
Returns the type of the chapter.
- Returns:
- TRUE if the chapter is an end chapter (or family), FALSE otherwise.
o ListDescriptions
public virtual HRESULT ListDescriptions( | CATListValCATICatalogDescription_var*& | oListDescriptions) = 0 |
-
Retrieves all descriptions on the chapter.
- Parameters:
-
- oListDescriptions
- The list of descriptions.
o ListKeywords
public virtual HRESULT ListKeywords( | CATListValCATICatalogKeyword_var*& | oListKeywords) = 0 |
-
Retrieves the list of keywords on the chapter.
- Parameters:
-
- oListKeywords
- The list of keywords.
o ListPersistentQuery
public virtual HRESULT ListPersistentQuery( | CATListValCATICatalogPersistentQuery_var*& | oListOfPersistentQuery) = 0 |
-
Retrieves the list of persistents queries on the chapter.
- Parameters:
-
- oListOfPersistentQuery
- The list of persistent queries.
o RemoveDescription
-
Removes a description on the chapter.
- Parameters:
-
- extObj
- The description to remove.
o RemoveKeyword
-
Removes a keyword on the chapter.
- Parameters:
-
- ioToBeRemoved
- The keyword to remove. This keyword must be released after.
o RemovePersistentQuery
-
Removes a persistent query on the chapter.
- Parameters:
-
- iPersistentQuery
- The persistent query to remove.
- iRemoveGeneratedDescription
- Indicates if the result of the query should be removed or not.
0 = Only the query will be removed.
1 = Descriptions that belong to the query will be removed.
o RenameKeyword
-
Renames one of the keywords of the chapter.
- Parameters:
-
- iKeyword
- The keyword to rename.
- iNewName
- The new name of the keyword to rename.
o SetDefaultValue
-
Sets a default value of a boolean type keyword.
Role:Every modification of the keyword default value automatically modifies
all descriptions without own values.
- Parameters:
-
- iName
- The name of keyword to modify.
- idefaultValue
- The new default value (boolean) for the keyword.
o SetDefaultValue
-
Sets a default value of a string type keyword.
Role:Every modification of the keyword default value automatically modifies all
descriptions without own values.
- Parameters:
-
- iName
- The name of keyword to modify.
- idefaultValue
- The new default value (string) for the keyword.
o SetDefaultValue
-
Sets a default value of a real type keyword.
Role:Every modification of the keyword default value automatically modifies all
descriptions without own values.
- Parameters:
-
- iName
- The name of keyword to modify.
- idefaultValue
- The new default value (real) for the keyword.
o SetDefaultValue
-
Sets a default value of an integer type keyword.
Role:Every modification of the keyword default value
automatically modifies all descriptions without own values.
- Parameters:
-
- iName
- The name of keyword to modify.
- idefaultValue
- The new default value (integer) for the keyword.
o UnsetDefaultValue
-
Removes the default value for a keyword.
Role:Every modification of keyword default value automatically modifies all
descriptions without own values.
- Parameters:
-
- iName
- The name of the keyword.
This object is included in the file: CATICatalogChapter.h
If needed, your Imakefile.mk should include the module: CATCclInterfaces