Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

int phImage::swap phObject obj  )  [virtual]
 

This is an empty swap method when it's not overloaded. The phLiveObject provides a mechanism to swap data when new data is available. This helps to reduce the number of copies where ever it's possible to do so. The swap method is similar to the copy method in that the checks should be performed in the overloading child class to check that the object is of a supported class type. In some instances of implementation, it may be more desirable to have phObject::swap call phObject::copy. ( See phLiveObject::disableSwap )

Parameters:
obj The object whose data will be swapped with the current instance of phObject (or whatever inheriting class this instance actually is).
Returns:
A value denoting the successful swapping of the pointers.
Return values:
phSUCCESS The method succeeded in swapping the internal data.
phFAIL The method failed to swap the internal data.

Reimplemented from phDataObject.

Definition at line 256 of file phImage.cpp.





Copyright (C) 2002 - 2007 Philip D.S. Thoren ( pthoren@users.sourceforge.net )
University Of Massachusetts at Lowell
Robotics Lab
SourceForge.net Logo

Generated on Sat Jun 16 02:44:54 2007 for phission by  doxygen 1.4.4