fileStreamObject.h

Engine/source/core/stream/fileStreamObject.h
Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _FILESTREAMOBJECT_H_
25#define _FILESTREAMOBJECT_H_
26
27#ifndef _STREAMOBJECT_H_
28#include "core/stream/streamObject.h"
29#endif
30
31#ifndef _FILESTREAM_H_
32#include "core/stream/fileStream.h"
33#endif
34
35
36class FileStreamObject : public StreamObject
37{
38   typedef StreamObject Parent;
39
40protected:
41   FileStream mFileStream;
42
43public:
44   FileStreamObject();
45   virtual ~FileStreamObject();
46   DECLARE_CONOBJECT(FileStreamObject);
47
48   virtual bool onAdd();
49
50   //-----------------------------------------------------------------------------
51   /// @brief Open a file
52   /// 
53   /// @param filename Name of file to open
54   /// @param mode One of #Torque::FS::File::Read, #Torque::FS::File::Write, #Torque::FS::File::ReadWrite or #Torque::FS::File::WriteAppend
55   /// @return true for success, false for failure
56   /// @see close()
57   //-----------------------------------------------------------------------------
58   bool open(const char *filename, Torque::FS::File::AccessMode mode);
59
60   //-----------------------------------------------------------------------------
61   /// @brief Close the file
62   /// 
63   /// @see open()
64   //-----------------------------------------------------------------------------
65   void close();
66};
67
68#endif // _FILESTREAMOBJECT_H_
69