CATPLMIntegrationAccess CATAdpAttributeSet
Usage: you must use this class as is. You should never derive it.
public class CATAdpAttributeSet
Class defining a set of attributes.
Role: provide a set of attributes made of an attribute name and a value.
Constructor and Destructor Index
- o
CATAdpAttributeSet(void)
- Constructs an attribute set.
- o
CATAdpAttributeSet(CATAdpAttributeSet&)
- Copy constructs an attribute set.
- o
~CATAdpAttributeSet(void)
- Destructs an attribute set.
Method Index
- o
AddAttribute(CATString&,CATUnicodeString&)
- Adds a new attribute to the attribute set.
- o
NextAttribute(int&,CATString&,CATUnicodeString&)
- Retrieves an attribute from the attribute set.
- o
operator =(CATAdpAttributeSet&)
- Affectation operator.
Constructor and Destructor
o CATAdpAttributeSet
| public CATAdpAttributeSet( | | ) |
-
Constructs an attribute set.
o CATAdpAttributeSet
| public CATAdpAttributeSet( | const | ) |
-
Copy constructs an attribute set.
o ~CATAdpAttributeSet
| public virtual ~CATAdpAttributeSet( | | ) |
-
Destructs an attribute set.
Methods
o AddAttribute
| public AddAttribute( | const | iAttributeId, |
| const | iAttributeValue) |
-
Adds a new attribute to the attribute set.
Role: Adds a new attribute (identifier/value) to the attribute set.
- Parameters:
-
- iAttributeId
- [in] The attribute name.
- iAttributeValue
- [in] The attribute value.
- Returns:
-
S_OK if the attribute was added in the set.S_FALSE if the attribute was already available in the set. Add query is ignored for this attribute name.E_FAIL if an internal error occured.E_INVALIDARG if an invalid attribute identifier (such as null string) was provided.
o NextAttribute
| public NextAttribute( | | ioPosition, |
| | oAttributeId, |
| | oAttributeValue) |
-
Retrieves an attribute from the attribute set.
Role: Enables to get the attributes being part of the attribute set.
- Parameters:
-
- ioPosition
- [inout] On input, it's the index of the attribute (specify 0 for the first attribute). On output, it will contain the index
of the next attribute.
- oAttributeId
- [out] The attribute name.
- oAttributeValue
- [out] The attribute value.
- Returns:
-
S_OK if everything ran ok.S_FALSE if no more attribute is available. All the attributes of the set were parsed.E_INVALIDARG if invalid position is provided.E_FAIL if a fatal error occured during the operation. Nothing was done during the operation.
o operator =
| public operator =( | const | ) |
-
Affectation operator.
- Returns:
- The copy of the attribute set.
This object is included in the file: CATAdpAttributeSet.h
If needed, your Imakefile.mk should include the module: CATPLMIntegrationAccess
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.