Equalizer  1.2.1
systemPipe.h
00001 
00002 /* Copyright (c) 2009-2011, Stefan Eilemann <eile@equalizergraphics.com>
00003  *                    2009, Maxim Makhinya
00004  *
00005  * This library is free software; you can redistribute it and/or modify it under
00006  * the terms of the GNU Lesser General Public License version 2.1 as published
00007  * by the Free Software Foundation.
00008  *  
00009  * This library is distributed in the hope that it will be useful, but WITHOUT
00010  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00011  * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
00012  * details.
00013  * 
00014  * You should have received a copy of the GNU Lesser General Public License
00015  * along with this library; if not, write to the Free Software Foundation, Inc.,
00016  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
00017  */
00018 
00019 #ifndef EQ_SYSTEM_PIPE_H
00020 #define EQ_SYSTEM_PIPE_H
00021 
00022 #include <eq/client/api.h>
00023 #include <eq/client/error.h> // enum
00024 #include <eq/client/types.h>
00025 #include <string>
00026 
00027 namespace eq
00028 {
00037     class SystemPipe
00038     {
00039     public:
00041         EQ_API SystemPipe( Pipe* parent );
00042 
00044         EQ_API virtual ~SystemPipe( );
00045 
00049         EQ_API virtual bool configInit( ) = 0;
00050 
00052         EQ_API virtual void configExit( ) = 0;
00054 
00056         Pipe* getPipe() { return _pipe; }
00057         
00059         const Pipe* getPipe() const { return _pipe; }
00060 
00062         EQ_API co::base::Error getError() const;
00063 
00064     protected:
00072         EQ_API void setError( const uint32_t error );
00074 
00075     private:
00077         Pipe* const _pipe;
00078 
00079         struct Private;
00080         Private* _private; // placeholder for binary-compatible changes
00081     };
00082 }
00083 
00084 #endif // EQ_SYSTEM_PIPE_H
00085 
Generated on Fri Jun 8 2012 15:44:32 for Equalizer 1.2.1 by  doxygen 1.8.0