FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

wordReListMatcher.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::wordReListMatcher
00026 
00027 Description
00028     A wrapper for matching a List of wordRe.
00029 
00030 Note
00031     The constructor should remain non-explicit. This allows automatic
00032     conversion from UList<wordRe> to wordReListMatcher in search
00033     functions.
00034 
00035 SourceFiles
00036     wordReListMatcherI.H
00037 
00038 \*---------------------------------------------------------------------------*/
00039 
00040 #ifndef wordReListMatcher_H
00041 #define wordReListMatcher_H
00042 
00043 #include "wordReList.H"
00044 
00045 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00046 
00047 namespace Foam
00048 {
00049 
00050 /*---------------------------------------------------------------------------*\
00051                       Class wordReListMatcher Declaration
00052 \*---------------------------------------------------------------------------*/
00053 
00054 class wordReListMatcher
00055 {
00056     // Private data
00057 
00058         //- Reference to underlying list
00059         const UList<wordRe>& reList_;
00060 
00061 public:
00062 
00063     // Constructors
00064 
00065         //- Construct from a List of wordRe
00066         inline wordReListMatcher(const UList<wordRe>&);
00067 
00068 
00069     // Member Functions
00070 
00071         // Access
00072 
00073             inline label size() const;
00074             inline bool  empty() const;
00075 
00076             //- Return underlying list of wordRe
00077             inline const UList<wordRe>& operator()() const;
00078 
00079 
00080     // Searching
00081 
00082             //- Return true if string matches any of the regular expressions
00083             //  Smart match as regular expression or as a string.
00084             //  Optionally specify a literal match only.
00085             inline bool match(const string&, bool literalMatch=false) const;
00086 
00087 };
00088 
00089 
00090 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00091 
00092 } // End namespace Foam
00093 
00094 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00095 
00096 #include "wordReListMatcherI.H"
00097 
00098 #endif
00099 
00100 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines