OSD_FileNode Class Reference

A class for 'File' and 'Directory' grouping common methods (file/directory manipulation tools). The "file oriented" name means files or directories which are in fact hard coded as files. More...

#include <OSD_FileNode.hxx>

Inheritance diagram for OSD_FileNode:

Public Member Functions
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.
bool	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.
bool	Failed () const
	Returns TRUE if an error occurs.
void	Reset ()
	Resets error counter to zero.
void	Perror ()
	Raises OSD_Error.
int	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.
	~OSD_FileNode ()=default
	Destructor is protected for safer inheritance.

Protected Attributes
OSD_Path	myPath
OSD_Error	myError

Detailed Description

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

Constructor & Destructor Documentation

OSD_FileNode() [1/2]

OSD_FileNode::OSD_FileNode ( )

protected

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() [2/2]

OSD_FileNode::OSD_FileNode ( const OSD_Path & Name )

protected

Instantiates the object FileNode storing its name. If a name is not found, it raises a program error.

~OSD_FileNode()

OSD_FileNode::~OSD_FileNode ( )

protecteddefault

Destructor is protected for safer inheritance.

Member Function Documentation

AccessMoment()

Quantity_Date OSD_FileNode::AccessMoment

(

)

Returns last write access. On UNIX, AccessMoment and CreationMoment return the same value.

Copy()

void OSD_FileNode::Copy

(

const OSD_Path &

ToPath

)

Copies <me> to another FileNode.

CreationMoment()

Quantity_Date OSD_FileNode::CreationMoment

(

)

Returns creation date. On UNIX, AccessMoment and CreationMoment return the same value.

Error()

int OSD_FileNode::Error

(

)

const

Returns error number if 'Failed' is TRUE.

Exists()

bool OSD_FileNode::Exists

(

)

Returns TRUE if <me> exists.

Failed()

bool OSD_FileNode::Failed

(

)

const

Returns TRUE if an error occurs.

Move()

void OSD_FileNode::Move

(

const OSD_Path &

NewPath

)

Moves <me> into another directory.

Path()

void OSD_FileNode::Path

(

OSD_Path &

Name

)

const

Gets file name and path.

Perror()

void OSD_FileNode::Perror

(

)

Raises OSD_Error.

Protection()

OSD_Protection OSD_FileNode::Protection

(

)

Returns access mode of <me>.

Remove()

void OSD_FileNode::Remove

(

)

Erases the FileNode from directory.

Reset()

void OSD_FileNode::Reset

(

)

Resets error counter to zero.

SetPath()

void OSD_FileNode::SetPath

(

const OSD_Path &

Name

)

Sets file name and path. If a name is not found, it raises a program error.

SetProtection()

void OSD_FileNode::SetProtection

(

const OSD_Protection &

Prot

)

Changes protection of the FileNode.

Field Documentation

myError

OSD_Error OSD_FileNode::myError

protected

myPath

OSD_Path OSD_FileNode::myPath

protected

---

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

• OSD_FileNode.hxx