library of assembled shared sources

http://lass.cocamware.com

xyz.h

Go to the documentation of this file.
00001 /** @file
00002  *  @author Bram de Greve (bramz@users.sourceforge.net)
00003  *  @author Tom De Muer (tomdemuer@users.sourceforge.net)
00004  *
00005  *  *** BEGIN LICENSE INFORMATION ***
00006  *  
00007  *  The contents of this file are subject to the Common Public Attribution License 
00008  *  Version 1.0 (the "License"); you may not use this file except in compliance with 
00009  *  the License. You may obtain a copy of the License at 
00010  *  http://lass.sourceforge.net/cpal-license. The License is based on the 
00011  *  Mozilla Public License Version 1.1 but Sections 14 and 15 have been added to cover 
00012  *  use of software over a computer network and provide for limited attribution for 
00013  *  the Original Developer. In addition, Exhibit A has been modified to be consistent 
00014  *  with Exhibit B.
00015  *  
00016  *  Software distributed under the License is distributed on an "AS IS" basis, WITHOUT 
00017  *  WARRANTY OF ANY KIND, either express or implied. See the License for the specific 
00018  *  language governing rights and limitations under the License.
00019  *  
00020  *  The Original Code is LASS - Library of Assembled Shared Sources.
00021  *  
00022  *  The Initial Developer of the Original Code is Bram de Greve and Tom De Muer.
00023  *  The Original Developer is the Initial Developer.
00024  *  
00025  *  All portions of the code written by the Initial Developer are:
00026  *  Copyright (C) 2004-2007 the Initial Developer.
00027  *  All Rights Reserved.
00028  *  
00029  *  Contributor(s):
00030  *
00031  *  Alternatively, the contents of this file may be used under the terms of the 
00032  *  GNU General Public License Version 2 or later (the GPL), in which case the 
00033  *  provisions of GPL are applicable instead of those above.  If you wish to allow use
00034  *  of your version of this file only under the terms of the GPL and not to allow 
00035  *  others to use your version of this file under the CPAL, indicate your decision by 
00036  *  deleting the provisions above and replace them with the notice and other 
00037  *  provisions required by the GPL License. If you do not delete the provisions above,
00038  *  a recipient may use your version of this file under either the CPAL or the GPL.
00039  *  
00040  *  *** END LICENSE INFORMATION ***
00041  */
00042 
00043 
00044 
00045 /** @class lass::prim::XYZ
00046  *  @brief cyclic iterator over xyz indices
00047  *  @author Bram de Greve [BdG]
00048  */
00049 
00050 #ifndef LASS_GUARDIAN_OF_INCLUSION_PRIM_XYZ_H
00051 #define LASS_GUARDIAN_OF_INCLUSION_PRIM_XYZ_H
00052 
00053 #include "prim_common.h"
00054 #include "../num/modulo.h"
00055 
00056 namespace lass
00057 {
00058 namespace prim
00059 {
00060 
00061 class LASS_DLL XYZ
00062 {
00063 public:
00064 
00065 
00066     enum { dimension = 3 };
00067 
00068     XYZ();
00069     XYZ(char iAxis);
00070     explicit XYZ(int iValue);
00071     explicit XYZ(const std::string& iAxis);
00072 
00073     const char axis() const;
00074     operator int() const { return value_; } /**< convert axis to integer.
00075                                                         0 == @a x, 1 == @a y, 2 == @a z */
00076 
00077     XYZ& operator++();
00078     XYZ& operator--();
00079     XYZ operator++(int);
00080     XYZ operator--(int);
00081 
00082     XYZ& operator+=(int iOffset);
00083     XYZ& operator-=(int iOffset);
00084 
00085 private:
00086 
00087     typedef num::Modulo<3, int> TValue;
00088 
00089     friend LASS_DLL bool LASS_CALL operator==(const XYZ& iA, const XYZ& iB);
00090 
00091     void reset(char iAxis);
00092 
00093     TValue value_;
00094 };
00095 
00096 LASS_DLL bool LASS_CALL operator==(const XYZ& iA, const XYZ& iB);
00097 LASS_DLL bool LASS_CALL operator==(const XYZ& iA, char iB);
00098 LASS_DLL bool LASS_CALL operator==(char iA, const XYZ& iB);
00099 LASS_DLL bool LASS_CALL operator==(const XYZ& iA, const std::string& iB);
00100 LASS_DLL bool LASS_CALL operator==(const std::string& iA, const XYZ& iB);
00101 
00102 LASS_DLL bool LASS_CALL operator!=(const XYZ& iA, const XYZ& iB);
00103 LASS_DLL bool LASS_CALL operator!=(const XYZ& iA, char iB);
00104 LASS_DLL bool LASS_CALL operator!=(char iA, const XYZ& iB);
00105 LASS_DLL bool LASS_CALL operator!=(const XYZ& iA, const std::string&  iB);
00106 LASS_DLL bool LASS_CALL operator!=(const std::string&  iA, const XYZ& iB);
00107 
00108 LASS_DLL XYZ LASS_CALL operator+(const XYZ& iA, int iOffset);
00109 LASS_DLL XYZ LASS_CALL operator-(const XYZ& iA, int iOffset);
00110 
00111 /** @relates lass::prim::XY
00112  */
00113 template <typename Char, typename Traits>
00114 std::basic_ostream<Char, Traits>& operator<<(std::basic_ostream<Char, Traits>& ioS, const XYZ& iXYZ)
00115 {
00116     ioS << iXYZ.axis();
00117     return ioS;
00118 }
00119 
00120 
00121 
00122 }
00123 
00124 }
00125 
00126 #define LASS_PRIM_HAVE_PY_EXPORT_TRAITS_XYZ
00127 #ifdef LASS_GUARDIAN_OF_INCLUSION_UTIL_PYOBJECT_PLUS_H
00128 #   include "pyobject_util.h"
00129 #endif
00130 
00131 #endif
00132 
00133 // EOF

Generated on Mon Nov 10 14:22:02 2008 for Library of Assembled Shared Sources by doxygen 1.5.7.1
SourceForge.net Logo