version.h
Go to the documentation of this file.
00001 /*
00002  * Copyright 2006-2008 The FLWOR Foundation.
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  * 
00008  * http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #ifndef ZORBA_VERSION_API_H
00017 #define ZORBA_VERSION_API_H
00018 
00019 #include <string>
00020 
00021 #include <zorba/config.h>
00022 
00023 namespace zorba {
00024 
00025   /**
00026    * Provide access to the version of %Zorba that is used
00027    */
00028   class ZORBA_DLL_PUBLIC Version
00029   { 
00030     protected:
00031       static int theMajorVersion;
00032       static int theMinorVersion;
00033       static int thePatchVersion;
00034 
00035     public:
00036       /** \brief Get the major version
00037        */
00038       static int 
00039       getMajorVersion();
00040 
00041       /** \brief Get the minor version
00042        */
00043       static int 
00044       getMinorVersion();
00045 
00046       /** \brief Get the patch version
00047        */
00048       static int 
00049       getPatchVersion();
00050 
00051       /** \brief Get the %Zorba version as std::string
00052        *
00053        * Form: MajorVersion.MinorVersion.PatchVersion
00054        */
00055       static std::string
00056       getVersion();
00057 
00058   };
00059 
00060   /** \brief Write the result of calling aVersiongetVersion() to the given
00061    *         output stream.
00062    */
00063   ZORBA_DLL_PUBLIC
00064   std::ostream& 
00065   operator<< (std::ostream& os, const Version& aVersion);
00066 
00067 
00068 } /* end namespace zorba */
00069 #endif
00070 /* vim:set et sw=2 ts=2: */
blog comments powered by Disqus