All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPDMBaseInterfaces Interface CATIPDMLogObject0
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIPDMLogObject0
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPDMLogObject0
Method Index
- o
GetModStatus(CATPDMModType*&,int&)
- For a log record that describes a modification (CATPDMLogStatusModified)
returns the list of modification performed on the entity
- o
GetPDMId(CATIPDMId0**)
- Returns the PDM identifier of the entity
WARNING for record representing a create operation(StatusNew), the identifier can not be returned
since not assigned yet
- o
GetPSTreeName(CATUnicodeString&)
- Returns the name of the feature that the record is associated to, as this feature is
named in the product structure tree
WARNING for record representing a delete operation, the name can not be returned
- o
GetStatus()
- Returns what kind of modification the log record corresponds to
See CATPDMLogStatus definition for the possible retuned status
- o
GetType(CATUnicodeString&)
- Returns the type of the feature that the record is associated to
This is typically the "late type" of the entity
WARNING for record representing a delete operation, the type can not be returned
Methods
o GetModStatus
-
For a log record that describes a modification (CATPDMLogStatusModified)
returns the list of modification performed on the entity
- Parameters:
-
- oModSt
- List of modifications. Memory should be freed by calling delete[] oModSt
- oNbMod
- Nb of modifications in the above list
- Returns:
- S_OK: Success
E_FAIL: The log record is not modification
o GetPDMId
-
Returns the PDM identifier of the entity
WARNING for record representing a create operation(StatusNew), the identifier can not be returned
since not assigned yet
- Parameters:
-
- oPDMId
- the returned PDM idendifier (after use, the returned pointer should be released)
- Returns:
- S_OK: Success
E_FAIL: No identifier returned (example new entity)
o GetPSTreeName
-
Returns the name of the feature that the record is associated to, as this feature is
named in the product structure tree
WARNING for record representing a delete operation, the name can not be returned
- Parameters:
-
- oName
- the returned name
- Returns:
- S_OK: Success
E_FAIL: No name returned (example deleted entity)
o GetStatus
-
Returns what kind of modification the log record corresponds to
See CATPDMLogStatus definition for the possible retuned status
o GetType
-
Returns the type of the feature that the record is associated to
This is typically the "late type" of the entity
WARNING for record representing a delete operation, the type can not be returned
- Parameters:
-
- oType
- the returned type
- Returns:
- S_OK: Success
E_FAIL: No name returned (example deleted entity)
This object is included in the file: CATIPDMLogObject0.h
If needed, your Imakefile.mk should include the module: CATPDMBaseItf