InteractiveInterfaces Interface CATIIniSearchWeightCriterion

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

interface CATIIniSearchWeightCriterion

Interface to define a search criterion based on lines' weight.
Role: This interface enables the complete definition of a search criterion on the weight 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 GetParameters(int&,CATIniSearchEnumeration::Comparison&)
Gets the weight parameter using the weight index.
o GetParameters(float&,CATIniSearchEnumeration::Comparison&)
Gets the weight parameter using a millimeter value.
o GetParameters(CATUnicodeString&,CATIniSearchEnumeration::Comparison&)
Gets the weight parameter using a character string.
o SetParameters(int,CATIniSearchEnumeration::Comparison)
Sets the weight parameter using the weight index.
o SetParameters(float,CATIniSearchEnumeration::Comparison)
Sets the weight parameter using a millimeter value.
o SetParameters(CATUnicodeString&,CATIniSearchEnumeration::Comparison)
Sets the weight parameter using a character string.

Methods


o GetParameters
public virtual GetParameters( iIndexValue,
oOperatingSign)
Gets the weight parameter using the weight index.
Role: This method gets the weight parameter using its index.
Parameters:
oIndexValue
The index representing the value.
oOperatingSign
The value corresponding to the desired operating sign.
All the values are authorized.
Returns:
E_FAIL if the criterion is not correctly retrieved.
S_OK otherwise.
o GetParameters
public virtual GetParameters( immValue,
oOperatingSign)
Gets the weight parameter using a millimeter value.
Role: This method gets the weight parameter thanks to a float representing the value in millimeters.
Parameters:
ommValue
The value in millimeters.
oOperatingSign
The value corresponding to the desired operating sign.
All the values are authorized.
Returns:
E_FAIL if the criterion is not correctly retrieved.
S_OK otherwise.
o GetParameters
public virtual GetParameters( oWeightString,
oOperatingSign)
Gets the weight parameter using a character string.
Role: This method gets the weight parameter thanks to a CATUnicodeString representing either the value in millimeters, or the index.
Parameters:
oWeightString
The string representing the value.
It could be in the following formats: 2.3mm or 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: Weight oOperatingSign iWeightString
    • oOperatingSign
    The value corresponding to the desired operating sign.
    All the values are authorized.
    Returns:
    E_FAIL if the criterion is not correctly retrieved.
    S_OK otherwise.
    o SetParameters
    public virtual SetParameters( iIndexValue,
    iOperatingSign)
    Sets the weight parameter using the weight index.
    Role: This method sets the weight parameter using its index.
    Parameters:
    iIndexValue
    The index representing the value.
    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( immValue,
    iOperatingSign)
    Sets the weight parameter using a millimeter value.
    Role: This method sets the weight parameter thanks to a float representing the value in millimeters.
    Parameters:
    immValue
    The value in millimeters.
    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 iWeightString,
    iOperatingSign)
    Sets the weight parameter using a character string.
    Role: This method sets the weight parameter thanks to a CATUnicodeString representing either the value in millimeters, or the index.
    Parameters:
    iWeightString
    The string representing the value.
    It could be in the following formats: 2.3mm or 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: Weight iOperatingSign iWeightString
    • 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: CATIIniSearchWeightCriterion.h
    If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces

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