InteractiveInterfaces Interface CATIIniDocumentFiltersDefinition

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

interface CATIIniDocumentFiltersDefinition

Interface for layers filter management.
Role: This interface is implemented on V6 concerned representations: Parts and Drawings.
To query or modify the filters do not implement this interface, just query the representation on this interface.
A filter is managed by a pointer to the interface.
The filters you will manage with this interface are stored with the representation in database
You may query this interface on the result object of , or on the objects in the result path of .

Method Index


o Add(CATIIniLayersFilter*&,CATUnicodeString,CATUnicodeString,FilterContentCheckMode,CATBoolean)
Creates a filter.
o Find(CATUnicodeString,CATIIniLayersFilter*&)
Retrieves a filter by its name.
o GetCurrent(CATIIniLayersFilter*&)
Retrieves the current filter.
o GetList(CATListPtrCATIIniLayersFilter*&)
Retrieves the layers filter list.
o Remove(CATIIniLayersFilter*&)
Removes a filter.
o SetCurrent(CATIIniLayersFilter*&)
Changes the current filter.

Enumerated Type Index


o FilterContentCheckMode
Check mode for layer filter description.

Methods


o Add
public virtual Add( opFilter,
iFilterName,
iFilterContent,
iCheckMode= NoCheck,
iDisplayError= FALSE)
Creates a filter. Role: Creates a new filter and adds it to the filters list.
Parameters:
opFilter
The created filter.
  • If no filter with same name or same content already exists, a new filter is created, its pointer is returned and the return code is S_OK.
  • If a filter with same name already exists, its description is changed, its pointer is returned and the return code is S_OK.
  • If a filter with same description already exists, its name is changed, its pointer is returned and the return code is S_OK.
  • If a filter with same description AND same name already exists, its pointer is returned and the return code is S_FALSE.
iFilterName
The name of the filter.
iFilterContent
The filter description.
iCheckMode
The filter description check mode.
iDisplayError
The filter check error display mode.
  • FALSE: No display (Default Value)
  • TRUE: Display a error within a dialog box
Returns:

Legal values:
  • S_OK if the filter was correctly created
  • S_FALSE if this filter already exists
  • E_FAIL if the filter could not be created
o Find
public virtual Find( iName,
opFilter)
Retrieves a filter by its name. Role:
Parameters:
iName
The filter name.
opFilter
The filter found.
Returns:

Legal values:
  • S_OK if the filter was found
  • E_FAIL if the filter does not exist
o GetCurrent
public virtual GetCurrent( opFilter)
Retrieves the current filter. Role:
Parameters:
opFilter
The filter set as current.
Returns:

Legal values:
  • S_OK if the current filter was found
  • E_FAIL if no current filter was found
o GetList
public virtual GetList( opList)
Retrieves the layers filter list. Role:
Parameters:
opList
The list of filters.
Returns:

Legal values:
  • S_OK if a filters list was found
  • E_FAIL no filters list was found
o Remove
public virtual Remove( ipFilter)
Removes a filter. Role: Deletes a filter and removes it from the filters list.
Parameters:
ipFilter
The filter to delete.
Returns:

Legal values:
  • S_OK if the filter was correctly removed
  • E_FAIL if the filter does not exist
o SetCurrent
public virtual SetCurrent( ipFilter)
Changes the current filter. Role: Sets a filter as the current one. This recomputes the visualization.
Parameters:
ipFilter
The filter to set as current.
Returns:

Legal values:
  • S_OK if the current filter was changed
  • E_FAIL if no current filter was found

Enumerated Types


o FilterContentCheckMode 
enum FilterContentCheckMode {
  NoCheck,
  CheckNLS,
  CheckAndConvert
}
Check mode for layer filter description. Role: Lists the different check modes that can be applied to a layer filter description.
Parameters:
NoCheck
No check at all
CheckNLS
Check NLS contents
CheckAndConvert
Check and convert from trans-format to NLS contents
This object is included in the file: CATIIniDocumentFiltersDefinition.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.