FeatureModelerExt CATFmEvent
Usage: you must use this class as is. You should never derive it.
public class CATFmEvent
Class representing an Event.
Role: This class provides methods for Events handling.
It is an iterator class, i.e. that has the ability to iterate through the elements of its range.
Method Index
- o
GetAttribute(CATFmAttributeName&)
- Retrieves the object's attribute affected by the event.
- o
GetObject(CATFmAttributeValue&)
- Retrieves the object on which the event is emitted.
- o
GetType()
- Returns the type of an Event.
- o
Next()
- Iterates to the next object on which the event is emitted.
Methods
o GetAttribute
| public GetAttribute( | | oAttribute) |
-
Retrieves the object's attribute affected by the event.
- Parameters:
-
- oAttribute
- [out] A (caller provided) Attribute Name in which the attribute will be stored.
If the method fails then oAttribute is not modified, otherwise it is overwritten with the retrieved value.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The attribute has been successfuly retrieved.
- E_FAIL
- There is no attribute corresponding to the event.
o GetObject
| public GetObject( | | oObject) |
-
Retrieves the object on which the event is emitted.
- Parameters:
-
- oObject
- [out] A (caller provided) Attribute Value in which the object will be stored.
If the method fails then oObject is not modified, otherwise it is overwritten with the retrieved value.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The object has been successfuly retrieved.
- E_FAIL
- The object cannot be retrieved.
o GetType
-
Returns the type of an Event.
- Returns:
- An Attribute Name containing the type of the event.
o Next
-
Iterates to the next object on which the event is emitted.
- Returns:
- An HRESULT value.
Legal values:
- S_OK
- The next object has been found.
- E_FAIL
- The iteration is over.
This object is included in the file: CATFmEvent.h
If needed, your Imakefile.mk should include the module: FeatureModelerExt
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.