gls_pointer_array.h

Go to the documentation of this file.

#ifndef _GLS_POINTER_ARRAY_H
#define _GLS_POINTER_ARRAY_H

/*! \file gls_pointer_array.h

\brief  This header defines GlsPointerArray which encapsulates an array of pointers
        in the GL Studio DO-178B Runtime Library.

\par Copyright Information
Copyright (C) 1999-2012 The DiSTI Corporation<br>
Orlando, FL USA<br>
All rights reserved.<br>

  This file is copyrighted software and contains proprietary trade secrets of
DiSTI, and embodies substantial creative efforts as well as confidential
information, ideas, and expressions.

  Permission to use, and copy this software and its documentation for any
purpose is hereby granted per the Distribution Agreement and/or the Licensing
Agreement signed with DiSTI. This permission is granted provided that:
    1.  The above copyright notice appears in all copies.
    2.  That both the copyright notice and this permission notice appear in
        the supporting documentation.
    3.  That the names DiSTI and GL Studio not be used in advertising or
        publicity pertaining to distribution of the software without specific,
        written prior permission of DiSTI.
 
  Permission to modify the software is granted, but not the right to
distribute the source code whether modified, or non-modified.  Modifying the
software might invalidate the DO-178B certification package.

  Permission to distribute binaries produced by compiling source code, or
modified source code is granted, provided you:
    1.  Provide your name and address as the primary contact for the support
        of your modified version.
    2.  Retain our contact information in regard to use of the base software. 

   DiSTI does not provide warranty for this software or guarantee that it
satisfies any specification or requirement unless otherwise stated in a
specific contractual arrangement between the customer and DiSTI.

*/

#include "gls_include.h"
#include "gls_types.h"
#include "gls_class_invariant.h"

/** Abstracts an array of pointers
  * \invariant _pointers array is GLS_NULL if _count == 0, else non GLS_NULL if _count > 0
  */
class GlsPointerArray
{
public:
    GLS_CLASS_INVARIANT_DECLARATION( GlsPointerArray )

    /** Constructor
      * \param size number of pointers this array will hold
      * \pre none
      * \post array constructed and initialized to GLS_NULL
      */
    GlsPointerArray( const GlsUInt32 size );

    /** Destructor - shall never be called
      * \pre none
      * \post none
      */
    virtual ~GlsPointerArray();

    /** Get the number of pointers in the array
      * \return number of pointers in the array
      * \pre none
      * \post none
      */
    GlsUInt32 GetSize( void ) const;

    /** Get a pointer in the array
      * \param index index of desired pointer
      * \return ref to pointer at given index
      * \pre index < GetSize()
      */
    void* GetPointer( const GlsUInt32 index );

    /** Get a const pointer in the array
      * \param index index of desired pointer
      * \return ref to pointer at given index
      * \pre index < GetSize()
      */
    const void* GetPointer( const GlsUInt32 index ) const;

    /** Set a pointer in the array
      * \param index index of pointer to set
      * \param src new value for pointer
      * \pre index < GetSize()
      * \post pointer at given index is set to src
      */
    void SetPointer( const GlsUInt32 index, void* const src );

protected:
    void** const    _pointers;  /**< array of pointers else GLS_NULL if count == 0 */
    const GlsUInt32 _count;     /**< number of pointers in pointers array */

private:
    // Disable implicit generated Members
    GlsPointerArray& operator=( const GlsPointerArray &rhs );
    GlsPointerArray( const GlsPointerArray &src );
};

#endif // _GLS_POINTER_ARRAY_H