All Frameworks Class Hierarchy This Framework Indexes Previous Next

InteractiveInterfaces Interface CATIIniLayersFilter

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

interface CATIIniLayersFilter

Interface to a layers filter.
Role: This interface gives a read access to a layers filter.
This interface is implemented on all the filters. The interface returns pointers to CATIIniLayersFilter and you can use CATIIniLayersFilter methods to retrieve the name or the comment of the corresponding filter.

Method Index

o GetContents(CATUnicodeString&,int): Read the filter description.
o GetName(CATUnicodeString&): Retrieves the filter name.

Methods

o GetContents

public virtual GetContents(		`oDescription`,
	const	`iFormat`	`= 0`)

Read the filter description. Role: Return the filter description in NLS. The filter description is the logical layer combination which defines the filter. For exemple, "(Layer > 2 & Layer <=4) + Layer = 0" defines a filter where only layers 3, 4 and 0 are visible. See Visualization Filters interactive command for more help.

Parameters:

iFormat

The filter description format.

0: As displayed - NLS contents (Default Value). The description is returned as it appears in the user interface
1: As stored. The description is returned as stored in the document.

oDescription

The filter description.

Returns:

Legal values:

S_OK if the read access succeeded
E_FAIL if the interface pointer is wrong

o GetName

public virtual GetName( oName)

Retrieves the filter name.

Parameters:

oName: The name of the filter.

Returns:

Legal values:

S_OK if the read access succeeded
E_FAIL if the interface pointer is wrong

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