zeus::TXSynchronAction Class Reference

#include <XSynchronAction.h>

Inheritance diagram for zeus::TXSynchronAction:

zeus::TZObject zeus::IXSynchronAction zeus::IZUnknown zeus::IZUnknown

List of all members.

Public Member Functions

 TXSynchronAction (IXObject *pNode1, IXObject *pNode2, ENodeActionType actionType=IXSynchronAction::etNodeUnchanged)
 TXSynchronAction (IXObject *pNode1, IXObject *pNode2, IXSynchronAction *pParent, ENodeActionType actionType=IXSynchronAction::etNodeUnchanged)
virtual Retval MQUALIFIER addNewChild (IXObject *pNode1, IXObject *pNode2, IXSynchronAction::ENodeActionType mType, IXSynchronAction *&pChild)
virtual void MQUALIFIER add (IXSynchronAction &pChild)
virtual Retval MQUALIFIER getNextChildOfAction (IXSynchronAction &rRefChild, IXSynchronAction *&rpNextChild)
virtual Int MQUALIFIER getCount () const
virtual Retval MQUALIFIER getChild (Int iIndex, IXSynchronAction *&pAction) const
virtual ENodeActionType MQUALIFIER getType () const
virtual Retval MQUALIFIER getNode1 (IXObject *&pNode) const
virtual Retval MQUALIFIER getNode2 (IXObject *&pNode) const
virtual Retval MQUALIFIER getParent (IXSynchronAction *&pParent) const
virtual void MQUALIFIER setParent (IXSynchronAction &pParent)
virtual void MQUALIFIER disable ()
virtual void MQUALIFIER enable ()
virtual bool MQUALIFIER isEnabled () const
virtual Retval MQUALIFIER executeAction (long lCycleCount=0, bool bUnfreeze=false, bool bCleanTree=false, IXSynchronActionListener *pListener=NULL)
virtual void MQUALIFIER getCaption (IString &rCaption) const
virtual Retval MQUALIFIER findAction (IXObject &rObject, IXSynchronAction *&rpAction)
virtual Int MQUALIFIER getSubActionCount () const
virtual Retval MQUALIFIER getErrorCode () const
virtual Retval MQUALIFIER checkPreConditions (Int iCycleID=0, bool bForce=false)
virtual void MQUALIFIER setRootObjectNotification (bool bFlag)
virtual Retval MQUALIFIER getRootAction (IXSynchronAction *&rpRoot) const
virtual Retval MQUALIFIER askForInterface (Uint uiInterfaceID, IZUnknown *&rpIface)
virtual void MQUALIFIER addRef () const
virtual void MQUALIFIER release () const

Static Public Member Functions

static bool isNodeEqual (IXMLNode &pSource, IXMLNode &rTarget, bool bRecurs=true)
static bool isNodeEqual (IXMLNode &pSource, IXMLNode &rTarget, const TSet< TString > &rExcludedAttributes, bool bRecurs=true)

Protected Member Functions

virtual ~TXSynchronAction ()
virtual Retval MQUALIFIER executeRecurs (Int iActCylceID, IXSynchronActionListener *pListener=NULL)
virtual void MQUALIFIER finishRecurs ()
virtual void MQUALIFIER cleanTargetTree ()
virtual void onStartExecuting (bool &rAbort)
virtual void onExecuted (bool, bool &rAbort)
virtual void onPostProcessing (bool)
bool isRootOfExecution ()
bool canUnfreeze ()
bool canCleanTree ()
void setErrorCode (Retval retErrorCode)

Protected Attributes

TManagedList< IXSynchronAction > m_lstChildren
 List of all children.
bool m_bRootObjectNotification
 Flag if the root must be notificated.

Detailed Description

This class implements the basic action object to synchronize two X-object trees

Constructor & Destructor Documentation

zeus::TXSynchronAction::TXSynchronAction ( IXObject *  pNode1,
IXObject *  pNode2,
ENodeActionType  actionType = IXSynchronAction::etNodeUnchanged 
)

zeus::TXSynchronAction::TXSynchronAction ( IXObject *  pNode1,
IXObject *  pNode2,
IXSynchronAction *  pParent,
ENodeActionType  actionType = IXSynchronAction::etNodeUnchanged 
)

TXSynchronAction::~TXSynchronAction (  )  [protected, virtual]

Destroys the synchronisation action

Member Function Documentation

bool zeus::TXSynchronAction::isNodeEqual ( IXMLNode &  pSource,
IXMLNode &  rTarget,
bool  bRecurs = true 
) [inline, static]

See also:
TXSynchronAction::isNodeEqual

bool TXSynchronAction::isNodeEqual ( IXMLNode &  pSource,
IXMLNode &  rTarget,
const TSet< TString > &  rExcludedAttributes,
bool  bRecurs = true 
) [static]

This method checks two nodes and returns true if they are equal

Parameters:
pSource : Source node to check
rTarget : Target node to check
bRecurs : Check nodes recursivly (with children)
Return values:
true : nodes are equal
false : Nodes are different

rExcludedAttributes.hasItem(strAttName)

Retval MQUALIFIER TXSynchronAction::addNewChild ( IXObject *  pNode1,
IXObject *  pNode2,
IXSynchronAction::ENodeActionType  mType,
IXSynchronAction *&  pChild 
) [virtual]

See IXSynchronAction

Implements zeus::IXSynchronAction.

void MQUALIFIER TXSynchronAction::add ( IXSynchronAction &  pChild  )  [virtual]

See IXSynchronAction

Implements zeus::IXSynchronAction.

Retval MQUALIFIER TXSynchronAction::getNextChildOfAction ( IXSynchronAction &  rRefChild,
IXSynchronAction *&  rpNextChild 
) [virtual]

See IXSynchronAction

Implements zeus::IXSynchronAction.

Int MQUALIFIER TXSynchronAction::getCount (  )  const [virtual]

See IXSynchronAction

Implements zeus::IXSynchronAction.

Retval MQUALIFIER TXSynchronAction::getChild ( Int  iIndex,
IXSynchronAction *&  pAction 
) const [virtual]

See IXSynchronAction

Implements zeus::IXSynchronAction.

IXSynchronAction::ENodeActionType MQUALIFIER TXSynchronAction::getType (  )  const [virtual]

See IXSynchronAction

Implements zeus::IXSynchronAction.

Retval MQUALIFIER TXSynchronAction::getNode1 ( IXObject *&  pNode  )  const [virtual]

See IXSynchronAction

Implements zeus::IXSynchronAction.

Retval MQUALIFIER TXSynchronAction::getNode2 ( IXObject *&  pNode  )  const [virtual]

See IXSynchronAction

Implements zeus::IXSynchronAction.

Retval MQUALIFIER TXSynchronAction::getParent ( IXSynchronAction *&  pParent  )  const [virtual]

See IXSynchronAction

Implements zeus::IXSynchronAction.

void MQUALIFIER TXSynchronAction::setParent ( IXSynchronAction &  pParent  )  [virtual]

See IXSynchronAction

Implements zeus::IXSynchronAction.

void MQUALIFIER TXSynchronAction::disable (  )  [virtual]

See IXSynchronAction

Implements zeus::IXSynchronAction.

void MQUALIFIER TXSynchronAction::enable (  )  [virtual]

See IXSynchronAction

Implements zeus::IXSynchronAction.

virtual bool MQUALIFIER zeus::TXSynchronAction::isEnabled (  )  const [inline, virtual]

Checks is an action is enabled.

Return values:
true : Action is enabled
false,: Action is disabled

Implements zeus::IXSynchronAction.

virtual Retval MQUALIFIER zeus::TXSynchronAction::executeAction ( long  lCycleCount = 0,
bool  bUnfreeze = false,
bool  bCleanTree = false,
IXSynchronActionListener *  pListener = NULL 
) [virtual]

void MQUALIFIER TXSynchronAction::getCaption ( IString &  rCaption  )  const [virtual]

See IXSynchronAction

Implements zeus::IXSynchronAction.

Retval MQUALIFIER TXSynchronAction::findAction ( IXObject &  rObject,
IXSynchronAction *&  rpAction 
) [virtual]

See also:
IXSynchronAction::findAction

Implements zeus::IXSynchronAction.

Int MQUALIFIER TXSynchronAction::getSubActionCount (  )  const [virtual]

See also:
IXSynchronAction::getSubActionCount

Implements zeus::IXSynchronAction.

Retval MQUALIFIER TXSynchronAction::getErrorCode (  )  const [virtual]

See also:
IXSynchronAction::getErrorCode

Implements zeus::IXSynchronAction.

Retval MQUALIFIER TXSynchronAction::checkPreConditions ( Int  iCycleID = 0,
bool  bForce = false 
) [virtual]

See also:
IXSynchronAction::checkPreConditions

Implements zeus::IXSynchronAction.

void MQUALIFIER zeus::TXSynchronAction::setRootObjectNotification ( bool  bFlag  )  [inline, virtual]

See also:
IXSynchronAction::setRootObjectNotification

Implements zeus::IXSynchronAction.

Retval MQUALIFIER TXSynchronAction::getRootAction ( IXSynchronAction *&  rpRoot  )  const [virtual]

See also:
IXSynchronAction::getRootAction

Implements zeus::IXSynchronAction.

virtual Retval MQUALIFIER zeus::TXSynchronAction::askForInterface ( Uint  uiInterfaceID,
IZUnknown *&  rpIface 
) [virtual]

Reimplemented from zeus::TZObject.

virtual void MQUALIFIER zeus::TXSynchronAction::addRef (  )  const [virtual]

See also:
IZUnknown::addRef

Reimplemented from zeus::TZObject.

virtual void MQUALIFIER zeus::TXSynchronAction::release (  )  const [virtual]

See also:
IZUnknown::release

Reimplemented from zeus::TZObject.

Retval MQUALIFIER TXSynchronAction::executeRecurs ( Int  iActCylceID,
IXSynchronActionListener *  pListener = NULL 
) [protected, virtual]

See also:
IXSynchronAction::executeRecurs

Implements zeus::IXSynchronAction.

void MQUALIFIER TXSynchronAction::finishRecurs (  )  [protected, virtual]

See also:
IXSynchronAction::finishRecurs

Implements zeus::IXSynchronAction.

void MQUALIFIER TXSynchronAction::cleanTargetTree (  )  [protected, virtual]

See also:
IXSynchronAction::cleanTargetTree

Implements zeus::IXSynchronAction.

virtual void zeus::TXSynchronAction::onStartExecuting ( bool &  rAbort  )  [inline, protected, virtual]

This call back can be used for subclasses to do some pre processing.

Parameters:
rAbort : if the flag is true, the executeAction will abort and return an error

virtual void zeus::TXSynchronAction::onExecuted ( bool  ,
bool &  rAbort 
) [inline, protected, virtual]

This call back can be used to access the xml data after the changes were made. Note that the child object were not processed at that time.

Parameters:
bErrorOccured : true = an error has been occured

virtual void zeus::TXSynchronAction::onPostProcessing ( bool   )  [inline, protected, virtual]

This call back can be used for subclasses to do some post processing

Parameters:
bErrorOccured : true = an error has been occured

bool zeus::TXSynchronAction::isRootOfExecution (  )  [inline, protected]

Returns true if the action is root of execution. The root of execution is valid during the execution of an action. After the execution the flag will be reset

bool zeus::TXSynchronAction::canUnfreeze (  )  [inline, protected]

Returns the unfreeze flag

bool zeus::TXSynchronAction::canCleanTree (  )  [inline, protected]

Returns the clean tree flag

void zeus::TXSynchronAction::setErrorCode ( Retval  retErrorCode  )  [inline, protected]

sets the error code of the action

Member Data Documentation

TManagedList<IXSynchronAction> zeus::TXSynchronAction::m_lstChildren [protected]

List of all children.

bool zeus::TXSynchronAction::m_bRootObjectNotification [protected]

Flag if the root must be notificated.

The documentation for this class was generated from the following files:

Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Wed Oct 28 21:42:36 2009