OpenFOAM logo
Open Source CFD Toolkit

colourPalette.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-2005 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 the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     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, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     colourPalette
00027 
00028 Description
00029 
00030 SourceFiles
00031     colourPalette.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef colourPalette_H
00036 #define colourPalette_H
00037 
00038 #include "colour.H"
00039 #include "List.H"
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 class Istream;
00047 
00048 /*---------------------------------------------------------------------------*\
00049                            Class colourPalette Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 class colourPalette
00053 :
00054     public List<colour>
00055 {
00056 
00057 public:
00058 
00059     // Constructors
00060 
00061         //- Construct from components
00062         colourPalette(const List<colour>&);
00063 
00064         //- Construct given number of colours
00065         colourPalette(const label);
00066 
00067         //- Construct from Istream
00068         colourPalette(Istream&);
00069 
00070 
00071     // Member Operators
00072 
00073         // Access
00074 
00075             const colour& operator()(const word&) const;
00076 };
00077 
00078 
00079 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00080 
00081 } // End namespace Foam
00082 
00083 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00084 
00085 #endif
00086 
00087 // ************************************************************************* //
For further information go to www.openfoam.org