InteractiveInterfaces Interface CATIIniSearchDashedCriterion

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

interface CATIIniSearchDashedCriterion

Interface to define a search criterion based on line types.
Role: This interface enables the complete definition of a search criterion on the dashed graphic attribute associated with 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 GetParameters(CATUnicodeString&,CATIniSearchEnumeration::Comparison&)
Retrives the dashed parameter using the index value.
o SetParameters(unsigned int,CATIniSearchEnumeration::Comparison)
Sets the dashed parameter using the index value.
o SetParameters(CATUnicodeString&,CATIniSearchEnumeration::Comparison)
Sets the dashed parameter using a character string.

Methods


o GetParameters
public virtual GetParameters( oDashedString,
oOperatingSign)
Retrives the dashed parameter using the index value.
Role: This method Retrives the dashed parameter thanks to the index value.
Parameters:
oDashedString
The index representing the type of dashed line.
oOperatingSign
The value corresponding to the desired operating sign.
The only authorized values are Equal and Different.
Returns:
  • E_FAIL if the criterion is not correctly set up.
  • S_OK otherwise.
o SetParameters
public virtual SetParameters( iDashedIndex,
iOperatingSign)
Sets the dashed parameter using the index value.
Role: This method sets the dashed parameter thanks to the index value.
Parameters:
iDashedIndex
The index representing the type of dashed line.
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: Dashed iOperatingSign iDashedIndex
    • iOperatingSign
    The value corresponding to the desired operating sign.
    The only authorized values are Equal and Different.
    Returns:
    • E_FAIL if the criterion is not correctly set up.
    • S_OK otherwise.
    o SetParameters
    public virtual SetParameters( const iDashedString,
    iOperatingSign)
    Sets the dashed parameter using a character string.
    Role: This method sets the dashed parameter thanks to a CATUnicodeString representing either the NLS name, or the index.
    Parameters:
    iDashedString
    The string representing the value.
    It could be in the following formats:
    • either the NLS format, Dotted, which can be retrieved from the Edit/Search user interface.
    • or the Transformat format, 3.

    To retrieve this last 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: Dashed iOperatingSign iDashedString
    • iOperatingSign
    The value corresponding to the desired operating sign.
    The only authorized values are Equal and Different.
    Returns:
    • E_FAIL if the criterion is not correctly set up.
    • S_OK otherwise.
    This object is included in the file: CATIIniSearchDashedCriterion.h
    If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces

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