All Frameworks Class Hierarchy This Framework Indexes Previous Next

InteractiveInterfaces Interface CATIIniSearchSymbolCriterion

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

interface CATIIniSearchSymbolCriterion

Interface to define a search criterion based on lines' Symbol.
Role: This interface enables the complete definition of a search criterion on the Symbol graphic attributes of lines.
Only objects that have the CATVPLine graphic property attribute implemented by the CATIVisProperties interface are taken into account in the search results.

Method Index

o SetParameters(unsigned int,CATIniSearchEnumeration::Comparison): Sets the Symbol parameter using the Symbol index.
o SetParameters(CATUnicodeString&,CATIniSearchEnumeration::Comparison): Sets the symbol parameter using a character string.

Methods

o SetParameters

public virtual SetParameters(		`iSymbolIndex`,
		`iOperatingSign`)

Sets the Symbol parameter using the Symbol index.
Role: This method sets the Symbol parameter using its index.

Parameters:

iSymbolIndex: The index representing the type of point symbol.
To retrieve this piece of information you can proceed as follows:
Record a macro command on a scenario based on the Edit/Search command with your Search query as input (NLS based query).

Check the macro file. It contains the query under the following format: Symbol iOperatingSign iSymbolIndex
iOperatingSign: The value corresponding to the desired operating sign.
All the values are authorized.

Returns:

E_FAIL if the criterion is not correctly set up.
S_OK otherwise.

o SetParameters

public virtual SetParameters(	const	`iSymbolString`,
		`iOperatingSign`)

Sets the symbol parameter using a character string.
Role: This method sets the symbol parameter thanks to a CATUnicodeString representing either the NLS name, or the index.

Parameters:

iSymbolString

The string representing the value.
It could be in the following formats:

either the NLS format, Cross, which can be retrieved from the Edit/Search user interface.
or the Transformat format, 3.

To retrieve this piece of information you can proceed as follows:

Record a macro command on a scenario based on the Edit/Search command with your Search query as input (NLS based query).

Check the macro file. It contains the query under the following format: Symbol iOperatingSign iSymbolString

iOperatingSign

The value corresponding to the desired operating sign.
All the values are authorized.

Returns:

E_FAIL if the criterion is not correctly set up.
S_OK otherwise.

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