List_Item.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       List_Item.h
//! @brief      List generic item class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2002-2021 ANVILEX
//!             $HeadURL:  $
//!             $Revision:  $
//!             $Date:  $
//!             $Author: minch $
//------------------------------------------------------------------------------
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of ANVILEX nor the names of its contributors may be
//    used to endorse or promote products derived from this software without
//    specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include project files
//------------------------------------------------------------------------------
 
#include "Defines.h"
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief List generic item class
class TList_Item
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method
    //! @note      None
    //! @param     [in] *object_Previous_Item - Pointer to the previous item
    //! @param     [in] *object_Next_Item - Pointer to the next item
    //! @param     [in] *object_Data - Pointer to the item data 
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TList_Item( TList_Item *object_Previous_Item, TList_Item *object_Next_Item, VOID *object_Data );
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    ~TList_Item();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get pointer to the previous item
    //! @note      None
    //! @return    TList_Item - Pointer to the previous item
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    TList_Item *Previous();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get pointer to the next item
    //! @note      None
    //! @return    TList_Item - Pointer to the next item
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    TList_Item *Next();  
 
    //!-------------------------------------------------------------------------
    //! @brief     Get pointer to the item data
    //! @note      None
    //! @return    VOID* - Pointer to the next item
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID *Data();           
 
    //!-------------------------------------------------------------------------
    //! @brief     Set pointer to the previous item
    //! @note      None
    //! @param     [in] *object_New_Previous_Item - Pointer to the new previous item
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Set_Previous( TList_Item *object_New_Previous_Item );
 
    //!-------------------------------------------------------------------------
    //! @brief     Set pointer to the next item
    //! @note      None
    //! @param     [in] *object_New_Next_Item - Pointer to the new next item
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Set_Next( TList_Item *object_New_Next_Item );  
        
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
  
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Pointer to previous item
    TList_Item *object_Previous_Item = (TList_Item*)NULL;  
 
    //! @brief Pointer to next item
    TList_Item *object_Next_Item = (TList_Item*)NULL;      
    
    //! @brief Pointer to data
    VOID *object_Data = (VOID*)NULL;                   
 
};
 
//------------------------------------------------------------------------------
// End of file 
//------------------------------------------------------------------------------