#include <IXObjectCompare.hpp>
List of all members.
Detailed Description
This interface is used to check two xobjects
Member Function Documentation
| virtual Retval MQUALIFIER zeus::IXObjectCompare::createAddAction |
( |
IXSynchronAction *& |
rpAction ) |
[pure virtual] |
This method is called to create an action for adding a x-object
- Parameters:
-
| rpAction | : Return parameter of an action |
- Return values:
-
| RET_NOERROR | : Action generated |
| RET_REQUEST_FAILED | : Could not generate an action |
| virtual Retval MQUALIFIER zeus::IXObjectCompare::createCompareAction |
( |
IXObject & |
rTargetObject, |
|
|
IXSynchronAction *& |
rpAction, |
|
|
bool |
bForce = false |
|
) |
| [pure virtual] |
This method is called to check if two x objects are differnt and creates the corresponding action
- Parameters:
-
| rTargetObject | : Target object |
| rpAction | : Return parameter of an action |
| bForce | : If this flag is set, a change is requested by the caller. The XObjectCompare-Object might still deny it |
- Return values:
-
| RET_NOERROR | : Action generated |
| RET_REQUEST_FAILED | : Could not generate an action |
| virtual Retval MQUALIFIER zeus::IXObjectCompare::createRemoveAction |
( |
IXSynchronAction *& |
rpAction ) |
[pure virtual] |
This method is called to create an action for removing a x-object
- Parameters:
-
| rpAction | : Return parameter of an action |
- Return values:
-
| RET_NOERROR | : Action generated |
| RET_REQUEST_FAILED | : Could not generate an action |
| virtual Retval MQUALIFIER zeus::IXObjectCompare::createRootAction |
( |
IXObject & |
rTargetObject, |
|
|
IXSynchronAction *& |
rpAction |
|
) |
| [pure virtual] |
This method is called to create the root action of the synchronisation tree. If there is not valid return it will automatically create a TXSynchronAction Object
- Parameters:
-
| rTargetObject | : Target object |
| rpAction | : Return parameter of an action |
- Return values:
-
| RET_NOERROR | : Action generated |
| RET_REQUEST_FAILED | : Could not generate an action |
| virtual void MQUALIFIER zeus::IXObjectCompare::onSynchronizeCylceFinished |
( |
bool |
bTarget, |
|
|
Int |
iActCycleIndex, |
|
|
bool |
bModified |
|
) |
| [pure virtual] |
Notification of the synchronizing process. The process has been finished for a given cyclye at that moment
- Parameters:
-
| bTarget | : true if the object node is the target node |
| iActCycleIndex | : Actual finished cycle |
| bModified | : This flag is set if the object has been modified |
| virtual void MQUALIFIER zeus::IXObjectCompare::onSynchronizeEnded |
( |
bool |
bTarget ) |
[pure virtual] |
Notification of the synchronizing process. The process has been ended at that moment
- Parameters:
-
| bTarget | : true if the object node is the target node |
| virtual void MQUALIFIER zeus::IXObjectCompare::onSynchronizeStarted |
( |
bool |
bTarget ) |
[pure virtual] |
Notification of the synchronizing process. The process has been started at that moment
- Parameters:
-
| bTarget | : true if the object node is the target node |
The documentation for this class was generated from the following file:
