CATPLMIntegrationUse CATAdpPLMQueryAttributeSet
Usage: you must use this class as is. You should never derive it.
public class CATAdpPLMQueryAttributeSet
Class defining a set of attributes.
Role: provide a set of attributes made of an attribute name and a value and operators for query.
Constructor and Destructor Index
- o
CATAdpPLMQueryAttributeSet()
- Constructs an attribute set.
- o
CATAdpPLMQueryAttributeSet(CATAdpPLMQueryAttributeSet&)
- Copy constructs an attribute set.
- o
~CATAdpPLMQueryAttributeSet()
- Destructs an attribute set.
Method Index
- o
AddAttribute(CATString&,CATIAdpPLMValueWriter*,CATAdpPLMQueryAttributeOperator::PLMQueryOperator&)
- Adds a new attribute to the query attribute set.
- o
AddStringAttribute(CATString&,CATUnicodeString&,CATAdpPLMQueryAttributeOperator::PLMQueryOperator&)
- Accelerator for STRING attributes : Adds a new attribute to the query attribute set if it is of type STRING.
- o
GetAdpPLMValueWriter(CATIAdpPLMValueWriter*&)
- Provides a
- o
operator =(CATAdpPLMQueryAttributeSet&)
- Affectation operator.
Constructor and Destructor
o CATAdpPLMQueryAttributeSet
| public CATAdpPLMQueryAttributeSet( | ) |
-
Constructs an attribute set.
o CATAdpPLMQueryAttributeSet
| public CATAdpPLMQueryAttributeSet( | const | ) |
-
Copy constructs an attribute set.
- Returns:
- The copy of the attribute set.
o ~CATAdpPLMQueryAttributeSet
| public virtual ~CATAdpPLMQueryAttributeSet( | ) |
-
Destructs an attribute set.
Methods
o AddAttribute
| public AddAttribute( | const | iAttributeId, |
| | iAttributeValue, |
| const | iOperator | =CATAdpPLMQueryAttributeOperator::COND_LIKE) |
-
Adds a new attribute to the query attribute set.
Role: Adds a new attribute (identifier/value) to the query attribute set.
- Parameters:
-
- iAttributeId
- [in] The attribute name.
- iAttributeValue
- [in] The attribute value. You can use #GetAdpPLMValueWriter to create an attribute value.
- iOperatorValue[in]
- The operator .
- Returns:
-
S_OK if the attribute was added in the set.E_FAIL if an internal error occured.E_INVALIDARG if an invalid attribute identifier (such as null string) was provided.
o AddStringAttribute
| public AddStringAttribute( | const | iAttributeId, |
| const | iAttributeValue, |
| const | iOperator | =CATAdpPLMQueryAttributeOperator::COND_LIKE) |
-
Accelerator for STRING attributes : Adds a new attribute to the query attribute set if it is of type STRING.
Role: Adds a new attribute (identifier/value) to the query attribute set if this attribute is of type STRING.
- Parameters:
-
- iAttributeId
- [in] The attribute name.
- iAttributeValue
- [in] The string attribute value.
- iOperatorValue[in]
- The operator .
- Returns:
-
S_OK if the attribute was added in the set.E_FAIL if an internal error occured.E_INVALIDARG if an invalid attribute identifier (such as null string) was provided.
o GetAdpPLMValueWriter
| public static GetAdpPLMValueWriter( | | oValueWriter) |
-
Provides a
pointer on an attribute value.
Role: Use this method if you need a CATIAdpPLMValueWriter pointer on an attribute value.
- Parameters:
-
- oValueWriter
- [out,CATBaseUnknown#Release] The out pointer.
- Returns:
-
S_OK if the method succeeded and provided you a good pointer on an attribute value.E_FAIL if an internal error occured.
o operator =
| public operator =( | const | ) |
-
Affectation operator.
This object is included in the file: CATAdpPLMQueryAttributeSet.h
If needed, your Imakefile.mk should include the module: CATPLMIntegrationUse
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.