diff options
Diffstat (limited to 'src/include/usr')
-rw-r--r-- | src/include/usr/targeting/common/iterators/targetiterator.H | 154 |
1 files changed, 77 insertions, 77 deletions
diff --git a/src/include/usr/targeting/common/iterators/targetiterator.H b/src/include/usr/targeting/common/iterators/targetiterator.H index 5abb21f81..8b3463f70 100644 --- a/src/include/usr/targeting/common/iterators/targetiterator.H +++ b/src/include/usr/targeting/common/iterators/targetiterator.H @@ -1,25 +1,25 @@ -// IBM_PROLOG_BEGIN_TAG -// This is an automatically generated prolog. -// -// $Source: src/include/usr/targeting/iterators/targetiterator.H $ -// -// IBM CONFIDENTIAL -// -// COPYRIGHT International Business Machines Corp. 2011 -// -// p1 -// -// Object Code Only (OCO) source materials -// Licensed Internal Code Source Materials -// IBM HostBoot Licensed Internal Code -// -// The source code for this program is not published or other- -// wise divested of its trade secrets, irrespective of what has -// been deposited with the U.S. Copyright Office. -// -// Origin: 30 -// -// IBM_PROLOG_END +/* IBM_PROLOG_BEGIN_TAG */ +/* This is an automatically generated prolog. */ +/* */ +/* $Source: src/include/usr/targeting/common/iterators/targetiterator.H $ */ +/* */ +/* IBM CONFIDENTIAL */ +/* */ +/* COPYRIGHT International Business Machines Corp. 2011,2013 */ +/* */ +/* p1 */ +/* */ +/* Object Code Only (OCO) source materials */ +/* Licensed Internal Code Source Materials */ +/* IBM HostBoot Licensed Internal Code */ +/* */ +/* The source code for this program is not published or otherwise */ +/* divested of its trade secrets, irrespective of what has been */ +/* deposited with the U.S. Copyright Office. */ +/* */ +/* Origin: 30 */ +/* */ +/* IBM_PROLOG_END_TAG */ #ifndef __TARGETING_COMMON_TARGETITERATOR_H #define __TARGETING_COMMON_TARGETITERATOR_H @@ -28,7 +28,7 @@ * @file targeting/common/iterators/targetiterator.H * * @brief Interface describing iterator/const iterator used to iterate through - * target service targets + * target service targets */ //****************************************************************************** @@ -63,12 +63,12 @@ namespace TARGETING #define TARG_CLASS "_TargetIterator<T>::" class Target; - + /** * @brief Class which iterates through targets managed by the target service. * Provides "Target*" and "const Target*" versions via templates - */ -template<typename T> + */ +template<typename T> class _TargetIterator { public: @@ -81,10 +81,10 @@ class _TargetIterator typedef T value_type; /** - * @brief Create an iterator to a (const/non-const) target handle. + * @brief Create an iterator to a (const/non-const) target handle. * Defaults to end() */ - ALWAYS_INLINE + ALWAYS_INLINE inline _TargetIterator() : iv_pCurrent(NULL) { @@ -93,145 +93,145 @@ class _TargetIterator /** * @brief Create an iterator to a (const/non-const) target handle * - * @param[in] i_pTarget Target handle (pointer or const pointer + * @param[in] i_pTarget Target handle (pointer or const pointer * depending on flavor) the iterator should reference */ - ALWAYS_INLINE - explicit _TargetIterator(T i_pTarget) + ALWAYS_INLINE inline + explicit _TargetIterator(T i_pTarget) : iv_pCurrent(i_pTarget) { - } + } /** - * @brief Destroy an iterator to a (const/non-const) target handle + * @brief Destroy an iterator to a (const/non-const) target handle * * @note Iterator does not own any resources to destroy */ - ALWAYS_INLINE + ALWAYS_INLINE inline ~_TargetIterator() { } - /** + /** * @brief Dereference the iterator (return what it points to) * * @return Target handle in form of Target* or const Target* * - * @note Returns NULL if it points to end(), should not be + * @note Returns NULL if it points to end(), should not be * dereferenced in this case. - */ - ALWAYS_INLINE + */ + ALWAYS_INLINE inline T operator* () const { // Only return copy of the target pointer (instead of a reference) - // because a reference will go out of scope when the iterator + // because a reference will go out of scope when the iterator // advances return iv_pCurrent; } - /** - * @brief Dereference the iterator (return what it points to) - * and (outside this function) call a function/member of + /** + * @brief Dereference the iterator (return what it points to) + * and (outside this function) call a function/member of * the referenced target * * @return Target handle in form of Target* or const Target* * - * @note Returns NULL if it points to end(), causing an + * @note Returns NULL if it points to end(), causing an * assert when automatically dereferenced. - */ - ALWAYS_INLINE + */ + ALWAYS_INLINE inline T operator->() const { // Only return copy of the target pointer (instead of a reference) - // because a reference will go out of scope when the iterator + // because a reference will go out of scope when the iterator // advances return iv_pCurrent; } - /** + /** * @brief Pre-increment the iterator * * @return The reference to the same iterator after advancing it - */ - ALWAYS_INLINE + */ + ALWAYS_INLINE inline _TargetIterator& operator++(); - /** + /** * @brief Post-increment the iterator * * @param[in] UNNAMED Dummy parameter used to distinguish * this interface from pre-increment * * @return Copy of the original iterator before it advanced - */ - ALWAYS_INLINE + */ + ALWAYS_INLINE inline _TargetIterator operator++(int); - - /** + + /** * @brief Determine if two iterators of same type are logically equal * * @param[in] i_rhs The other iterator to compare - * + * * @return bool indicating whether the iterators point to the same * entity - * + * * @retval true Iterators point to same entity * @retval false Iterators do not point to same entity - */ - ALWAYS_INLINE + */ + ALWAYS_INLINE inline bool operator==(const _TargetIterator& i_rhs) const { return (iv_pCurrent == i_rhs.iv_pCurrent); } - /** - * @brief Determine if two iterators of same type are logically not + /** + * @brief Determine if two iterators of same type are logically not * equal * * @param[in] i_rhs The other iterator to compare - * + * * @return bool indicating whether the iterators point to a different * logical entity - * + * * @retval true Iterators point to different entity * @retval false Iterators point to same entity - */ - ALWAYS_INLINE + */ + ALWAYS_INLINE inline bool operator!=(const _TargetIterator& i_rhs) const { return (iv_pCurrent != i_rhs.iv_pCurrent); } - /** + /** * @brief Assignment operator; assign iterator to another (such that * they logically point to same entity) * * @param[in] i_rhs The iterator to assign - * + * * @return Reference to the iterator, now updated to point to the same * entity as the input iterator points to - */ - ALWAYS_INLINE + */ + ALWAYS_INLINE inline _TargetIterator& operator=(const _TargetIterator& i_rhs) { iv_pCurrent = i_rhs.iv_pCurrent; return *this; } - /** - * @brief Copy constructor; assign iterator to a new iterator (such + /** + * @brief Copy constructor; assign iterator to a new iterator (such * that they logically point to same entity) * * @param[in] i_rhs The iterator to assign - */ - ALWAYS_INLINE - _TargetIterator(const _TargetIterator& i_rhs) + */ + ALWAYS_INLINE inline + _TargetIterator(const _TargetIterator& i_rhs) : iv_pCurrent(i_rhs.iv_pCurrent) { } private: - + /** * @brief Advance the iterator to point to the next item maintained by * the target service (or end() if end of list) @@ -246,19 +246,19 @@ class _TargetIterator */ typedef _TargetIterator<Target*> TargetIterator; typedef _TargetIterator<const Target*> ConstTargetIterator; - + //****************************************************************************** // _TargetIterator::operator++ (postincrement) //****************************************************************************** template<typename T> -_TargetIterator<T> _TargetIterator<T>::operator++(int) +_TargetIterator<T> _TargetIterator<T>::operator++(int) { _TargetIterator l_originalIterator(*this); advance(); return l_originalIterator; } - + //****************************************************************************** // _TargetIterator::operator++ (preincrement) //****************************************************************************** |