dtk_stream.hpp

Go to the documentation of this file.

#ifndef __UTIL_DTK_STREAM_HPP__
#define __UTIL_DTK_STREAM_HPP__
 
#include "def/define.h"
#include "util/BaseTypes/dtk_object.hpp"
#include "util/BaseTypes/dtk_string.hpp"
#include "util/util_ptr_dtk.hpp"
#include <memory>
 
 
//! \class Dtk_Stream 
//! \brief This is the Dtk_Stream Class.\n
//! The Dtk_Stream object is used to store any informations about stream file
//! \SmartPtr{Dtk_StreamPtr}
 
class Dtk_Stream : public Dtk_Object
{
public:
          enum Dtk_StreamType
          {
               DTK_STREAM_UNKNOWN,
               DTK_STREAM_X_B,
               DTK_STREAM_JT,
               DTK_STREAM_XMM_B,
          };
protected:
     struct Dtk_Handle; // Not defined here
     std::unique_ptr<Dtk_Handle> _Private; // Handle
     enum
     {
          _typeID = DTK_TYPE_STREAM
     };
     // \sa Create( const Dtk_string &, const Dtk_Char8 *const, const Dtk_Size_t&, Dtk_StreamType )
     Dtk_Stream(const Dtk_string &inName, const Dtk_Char8 *const inBinaryContent,
          const Dtk_Size_t & inBinaryContentSize, Dtk_StreamType inType);
     // \sa Create( const Dtk_Stream & )
     Dtk_Stream(const Dtk_Stream &in);
     Dtk_Stream( Dtk_Stream&& o ) DTK_NOEXCEPT;
     //! \BaseDestructor
     ~Dtk_Stream();
 
     inline virtual Dtk_Object* Clone()
     {
          return new Dtk_Stream(*this);
     }
 
private:
     friend class Dtk_SmartPtr<Dtk_Stream>;
public:
 
     //! \DtkDynamicType
     Dtk_Int32 DtkDynamicType(const Dtk_Int32 &inId);
 
     //! \DtkDynamicCast
     static Dtk_Stream* DtkDynamicCast(Dtk_Object *o);
 
     //! \brief Create a Dtk_StreamPtr.
     //! \param binaryContent file data.
     //! \param binaryContentSize file size.
     static Dtk_StreamPtr Create(const Dtk_string &inName, const Dtk_Char8 *const inBinaryContent,
          const Dtk_Size_t & inBinaryContentSize, Dtk_StreamType inType);
 
     //! \CreateCopy{in}
     static Dtk_StreamPtr Create(const Dtk_Stream &in);
 
     type_detk get_type_detk() const
     {
          return DTK_TYPE_STREAM;
     }
 
     //! \brief Returns the file name.
     Dtk_string GetName() const;
     //! \brief Returns the file data.
     const Dtk_Size_t GetBinaryContentSize() const;
     //! \brief Returns the file size.
     const Dtk_Char8 *const GetBinaryContent() const;
 
     //! \brief Set the file data.
     //! \param inNewContent The file data.
     //! \param inNewContentSize The file data size.
     void SetBinaryContent(const Dtk_Char8 *const inNewContent,
          const Dtk_Size_t inNewContentSize);
 
     //! \brief Returns the stream type.
     Dtk_StreamType GetStreamType() const;
 
 
 
};
 
#endif