Main Page   Class Hierarchy   Compound List   File List   Compound Members  

ValueArrayOf.hpp

00001 /*
00002  * The Apache Software License, Version 1.1
00003  * 
00004  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
00005  * reserved.
00006  * 
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  * 
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer. 
00013  * 
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  * 
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:  
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  * 
00026  * 4. The names "Xerces" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written 
00029  *    permission, please contact apache\@apache.org.
00030  * 
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  * 
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  * 
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation, and was
00051  * originally based on software copyright (c) 1999, International
00052  * Business Machines, Inc., http://www.ibm.com .  For more information
00053  * on the Apache Software Foundation, please see
00054  * <http://www.apache.org/>.
00055  */
00056 
00057 /*
00058  * $Log: ValueArrayOf.hpp,v $
00059  * Revision 1.1  2002/05/11 21:15:25  bhavani
00060  * CR#CR062582# adding xercesc 1.7 file
00061  *
00062  * Revision 1.1.1.1  2002/02/01 22:22:13  peiyongz
00063  * sane_include
00064  *
00065  * Revision 1.4  2000/03/02 19:54:47  roddey
00066  * This checkin includes many changes done while waiting for the
00067  * 1.1.0 code to be finished. I can't list them all here, but a list is
00068  * available elsewhere.
00069  *
00070  * Revision 1.3  2000/02/24 20:05:26  abagchi
00071  * Swat for removing Log from API docs
00072  *
00073  * Revision 1.2  2000/02/06 07:48:05  rahulj
00074  * Year 2K copyright swat.
00075  *
00076  * Revision 1.1.1.1  1999/11/09 01:05:27  twl
00077  * Initial checkin
00078  *
00079  * Revision 1.2  1999/11/08 20:45:18  rahul
00080  * Swat for adding in Product name and CVS comment log variable.
00081  *
00082  */
00083 
00084 
00085 #if !defined(VALUEARRAY_HPP)
00086 #define VALUEARRAY_HPP
00087 
00088 #include <xercesc/util/XercesDefs.hpp>
00089 #include <xercesc/util/XMLEnumerator.hpp>
00090 #include <xercesc/util/ArrayIndexOutOfBoundsException.hpp>
00091 #include <xercesc/util/IllegalArgumentException.hpp>
00092 
00093 template <class TElem> class ValueArrayOf
00094 {
00095 public :
00096     // -----------------------------------------------------------------------
00097     //  Contructors and Destructor
00098     // -----------------------------------------------------------------------
00099     ValueArrayOf(const unsigned int size);
00100         ValueArrayOf(const TElem* values, const unsigned int size);
00101         ValueArrayOf(const ValueArrayOf<TElem>& source);
00102         ~ValueArrayOf();
00103 
00104 
00105     // -----------------------------------------------------------------------
00106     //  Public operators
00107     // -----------------------------------------------------------------------
00108         TElem& operator[](const unsigned int index);
00109         const TElem& operator[](const unsigned int index) const;
00110         ValueArrayOf<TElem>& operator=(const ValueArrayOf<TElem>& toAssign);
00111         bool operator==(const ValueArrayOf<TElem>& toCompare) const;
00112         bool operator!=(const ValueArrayOf<TElem>& toCompare) const;
00113 
00114 
00115     // -----------------------------------------------------------------------
00116     //  Copy operations
00117     // -----------------------------------------------------------------------
00118     unsigned int copyFrom(const ValueArrayOf<TElem>& srcArray);
00119 
00120 
00121     // -----------------------------------------------------------------------
00122     //  Getter methods
00123     // -----------------------------------------------------------------------
00124         unsigned int length() const;
00125         TElem* rawData() const;
00126 
00127 
00128     // -----------------------------------------------------------------------
00129     //  Miscellaneous methods
00130     // -----------------------------------------------------------------------
00131     void resize(const unsigned int newSize);
00132 
00133 
00134 private :
00135     // -----------------------------------------------------------------------
00136     //  Data members
00137     // -----------------------------------------------------------------------
00138         unsigned int    fSize;
00139         TElem*          fArray;
00140 };
00141 
00142 
00143 //
00144 //  An enumerator for a value array. It derives from the basic enumerator
00145 //  class, so that value vectors can be generically enumerated.
00146 //
00147 template <class TElem> class ValueArrayEnumerator : public XMLEnumerator<TElem>
00148 {
00149 public :
00150     // -----------------------------------------------------------------------
00151     //  Constructors and Destructor
00152     // -----------------------------------------------------------------------
00153     ValueArrayEnumerator
00154     (
00155                 ValueArrayOf<TElem>* const toEnum
00156         , const bool                       adopt = false
00157     );
00158     ~ValueArrayEnumerator();
00159 
00160 
00161     // -----------------------------------------------------------------------
00162     //  Enum interface
00163     // -----------------------------------------------------------------------
00164     bool hasMoreElements() const;
00165     TElem& nextElement();
00166     void Reset();
00167 
00168 
00169 private :    
00170     // -----------------------------------------------------------------------
00171     //  Data Members
00172     //
00173     //  fAdopted
00174     //      Indicates whether we have adopted the passed vector. If so then
00175     //      we delete the vector when we are destroyed.
00176     //
00177     //  fCurIndex
00178     //      This is the current index into the vector.
00179     //
00180     //  fToEnum
00181     //      The value array being enumerated.
00182     // -----------------------------------------------------------------------
00183     bool                    fAdopted;
00184     unsigned int            fCurIndex;
00185     ValueArrayOf<TElem>*    fToEnum;
00186 };
00187 
00188 
00189 #if !defined(XERCES_TMPLSINC)
00190 #include <xercesc/util/ValueArrayOf.c>
00191 #endif
00192 
00193 #endif

Generated on Tue Nov 19 09:36:33 2002 by doxygen1.3-rc1