- Main Page
- Related Pages
- Modules
- Classes
- Files

# ByteStreamReader.h

Go to the documentation of this file.

    00001 #ifndef FDO_IO_BYTESTREAMREADER_H
    00002 #define FDO_IO_BYTESTREAMREADER_H
    00003 //
    00004
    00005 //
    00006 // Copyright (C) 2004-2006  Autodesk, Inc.
    00007 //
    00008 // This library is free software; you can redistribute it and/or
    00009 // modify it under the terms of version 2.1 of the GNU Lesser
    00010 // General Public License as published by the Free Software Foundation.
    00011 //
    00012 // This library is distributed in the hope that it will be useful,
    00013 // but WITHOUT ANY WARRANTY; without even the implied warranty of
    00014 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    00015 // Lesser General Public License for more details.
    00016 //
    00017 // You should have received a copy of the GNU Lesser General Public
    00018 // License along with this library; if not, write to the Free Software
    00019 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    00020 //
    00021
    00022 #include <FdoCommon.h>
    00023 #include <Common/Io/ObjectStreamReader.h>
    00024
    00025 /// \brief
    00026 /// FdoIoObjectStreamReader is the template for all
    00027 /// readers on FdoIoStream. Readers for various sized objects
    00028 /// or primitive types can be based on this class.
    00029 class FdoIoByteStreamReader : public FdoIoObjectStreamReader<FdoByte>
    00030 {
    00031 public:
    00032
    00033     /// \brief
    00034     /// Creates a Byte Stream reader. Reads binary data from
    00035     /// a FdoIoStream
    00036     ///
    00037     /// \param stream
    00038     /// Input the stream to read from
    00039     ///
    00040     /// \return
    00041     /// Returns FdoIoByteStreamReader
    00042     ///
    00043     FDO_API_COMMON static FdoIoByteStreamReader* Create( FdoIoStream* stream );
    00044
    00045     /// \return
    00046     /// Returns FdoStreamReaderType_Byte
    00047     ///
    00048     FDO_API_COMMON virtual FdoStreamReaderType GetType();
    00049
    00050 protected:
    00051 /// \cond DOXYGEN-IGNORE
    00052     FdoIoByteStreamReader();
    00053     FdoIoByteStreamReader( FdoIoStream* stream );
    00054 /// \endcond
    00055
    00056     FDO_API_COMMON virtual void Dispose();
    00057
    00058 };
    00059
    00060 /// \ingroup (typedefs)
    00061 /// \brief
    00062 /// FdoIoByteStreamReaderP is a FdoPtr on FdoIoByteStreamReader, provided for convenience.
    00063 typedef FdoPtr<FdoIoByteStreamReader> FdoIoByteStreamReaderP;
    00064
    00065 #endif
    00066
    00067

Please send us your comment about this page