OSD_FileNode Class Reference

A class for 'File' and 'Directory' grouping common
methods.
The "file oriented" name means files or directories which are
in fact hard coded as files.

#include <OSD_FileNode.hxx>

Inheritance diagram for OSD_FileNode:

Public Member Functions
DEFINE_STANDARD_ALLOC void	Path (OSD_Path &Name) const
	Gets file name and path.
void	SetPath (const OSD_Path &Name)
	Sets file name and path. If a name is not found, it raises a program error.
Standard_Boolean	Exists ()
	Returns TRUE if <me> exists.
void	Remove ()
	Erases the FileNode from directory
void	Move (const OSD_Path &NewPath)
	Moves <me> into another directory
void	Copy (const OSD_Path &ToPath)
	Copies <me> to another FileNode
OSD_Protection	Protection ()
	Returns access mode of <me>.
void	SetProtection (const OSD_Protection &Prot)
	Changes protection of the FileNode
Quantity_Date	AccessMoment ()
	Returns last write access. On UNIX, AccessMoment and CreationMoment return the same value.
Quantity_Date	CreationMoment ()
	Returns creation date. On UNIX, AccessMoment and CreationMoment return the same value.
Standard_Integer	UserId ()
	Returns User Identification.
Standard_Integer	GroupId ()
	Returns Group Identification.
Standard_Boolean	Failed () const
	Returns TRUE if an error occurs
void	Reset ()
	Resets error counter to zero
void	Perror ()
	Raises OSD_Error
Standard_Integer	Error () const
	Returns error number if 'Failed' is TRUE.
Protected Member Functions
	OSD_FileNode ()
	Creates FileNode object This is to be used with SetPath . Allocate space for the file name and initializes this name to an empty name.
	OSD_FileNode (const OSD_Path &Name)
	Instantiates the object FileNode storing its name. If a name is not found, it raises a program error.
Protected Attributes
OSD_Path	myPath
Standard_Integer	myFileChannel
OSD_Error	myError

---

Constructor & Destructor Documentation

OSD_FileNode::OSD_FileNode

(

)

[protected]

OSD_FileNode::OSD_FileNode

(

const OSD_Path &

Name

)

[protected]

---

Member Function Documentation

Quantity_Date OSD_FileNode::AccessMoment

(

)

void OSD_FileNode::Copy

(

const OSD_Path &

ToPath

)

Quantity_Date OSD_FileNode::CreationMoment

(

)

Standard_Integer OSD_FileNode::Error

(

)

const

Standard_Boolean OSD_FileNode::Exists

(

)

Standard_Boolean OSD_FileNode::Failed

(

)

const

Standard_Integer OSD_FileNode::GroupId

(

)

void OSD_FileNode::Move

(

const OSD_Path &

NewPath

)

DEFINE_STANDARD_ALLOC void OSD_FileNode::Path

(

OSD_Path &

Name

)

const

void OSD_FileNode::Perror

(

)

OSD_Protection OSD_FileNode::Protection

(

)

void OSD_FileNode::Remove

(

)

void OSD_FileNode::Reset

(

)

void OSD_FileNode::SetPath

(

const OSD_Path &

Name

)

void OSD_FileNode::SetProtection

(

const OSD_Protection &

Prot

)

Standard_Integer OSD_FileNode::UserId

(

)

---

Field Documentation

OSD_Error OSD_FileNode::myError [protected]

Standard_Integer OSD_FileNode::myFileChannel [protected]

OSD_Path OSD_FileNode::myPath [protected]

---

The documentation for this class was generated from the following file:

• OSD_FileNode.hxx