summaryrefslogtreecommitdiff
path: root/inc/OSD_FileNode.hxx
blob: 1df85ec0b2257ab243b28243c57c678a7a468994 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _OSD_FileNode_HeaderFile
#define _OSD_FileNode_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _OSD_Path_HeaderFile
#include <OSD_Path.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _OSD_Error_HeaderFile
#include <OSD_Error.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class OSD_OSDError;
class Standard_ProgramError;
class OSD_Path;
class OSD_Protection;
class Quantity_Date;


//! A class for 'File' and 'Directory' grouping common <br>
//!          methods. <br>
//!          The "file oriented" name means files or directories which are <br>
//!          in fact hard coded as files. <br>
class OSD_FileNode  {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  //! Gets file name and path. <br>
  Standard_EXPORT     void Path(OSD_Path& Name) const;
  //! Sets file name and path. <br>
//!          If a name is not found, it raises a program error. <br>
  Standard_EXPORT     void SetPath(const OSD_Path& Name) ;
  //! Returns TRUE if <me> exists. <br>
  Standard_EXPORT     Standard_Boolean Exists() ;
  //! Erases the FileNode from directory <br>
  Standard_EXPORT     void Remove() ;
  //! Moves <me> into another directory <br>
  Standard_EXPORT     void Move(const OSD_Path& NewPath) ;
  //! Copies <me> to another FileNode <br>
  Standard_EXPORT     void Copy(const OSD_Path& ToPath) ;
  //! Returns access mode of <me>. <br>
  Standard_EXPORT     OSD_Protection Protection() ;
  //! Changes protection of the FileNode <br>
  Standard_EXPORT     void SetProtection(const OSD_Protection& Prot) ;
  //! Returns last write access. <br>
//!          On UNIX, AccessMoment and CreationMoment return the <br>
//!          same value. <br>
  Standard_EXPORT     Quantity_Date AccessMoment() ;
  //! Returns creation date. <br>
//!          On UNIX, AccessMoment and CreationMoment return the <br>
//!          same value. <br>
  Standard_EXPORT     Quantity_Date CreationMoment() ;
  //! Returns User Identification. <br>
  Standard_EXPORT     Standard_Integer UserId() ;
  //! Returns Group Identification. <br>
  Standard_EXPORT     Standard_Integer GroupId() ;
  //! Returns TRUE if an error occurs <br>
  Standard_EXPORT     Standard_Boolean Failed() const;
  //! Resets error counter to zero <br>
  Standard_EXPORT     void Reset() ;
  //! Raises OSD_Error <br>
  Standard_EXPORT     void Perror() ;
  //! Returns error number if 'Failed' is TRUE. <br>
  Standard_EXPORT     Standard_Integer Error() const;





protected:

  //! Creates FileNode object <br>
//!          This is to be used with SetPath . <br>
//!          Allocate space for the file name and initializes this <br>
//!          name to an empty name. <br>
  Standard_EXPORT   OSD_FileNode();
  //! Instantiates the object FileNode storing its name. <br>
//!          If a name is not found, it raises a program error. <br>
  Standard_EXPORT   OSD_FileNode(const OSD_Path& Name);


OSD_Path myPath;
Standard_Integer myFileChannel;
OSD_Error myError;


private:





};





// other Inline functions and methods (like "C++: function call" methods)


#endif