File Class Reference

#include <file.h>

Public Member Functions
	File (std::string name)
bool	add_dependency (File *file, bool absolute)
bool	remove_dependency (File *file)
std::string	name () const
FileDependencySet *	dependencies ()
FileDependentSet *	dependents ()

Protected Member Functions
bool	add_dependent (File *file, bool absolute)
bool	remove_dependent (File *file)

Detailed Description

File class, represents a File and stores all dependency information.

Constructor & Destructor Documentation

File::File

(

std::string

name

)

The constructor for the File class taking only one argument, its name.

Parameters

name	The name of the file.

Member Function Documentation

bool File::add_dependency	(	File *	file,
		bool	absolute
	)

Adds a dependency to another file.

Parameters

file	The pointer to the File object which the dependency points to.
absolute	The dependency type, absolute/not absolute.

Returns

true if successfully added, false if it already existed.

bool File::add_dependent ( File *  file, bool  absolute  )

protected

A protected method that is called inside the add_dependency method.

Parameters

file	The pointer to the File object which the dependency points to.
absolute	The dependency type, absolute/not absolute.

Returns

true if successfully added, false if it already existed.

See Also

add_dependency

FileDependencySet * File::dependencies

(

)

Returns a set of file dependencies (outgoing dependencies).

Returns

A set of file dependencies (outgoing dependencies).

FileDependentSet * File::dependents

(

)

Returns a set of file dependents (incoming dependencies).

Returns

A set of file dependents (incoming dependencies).

std::string File::name

(

)

const

Returns the name of the file.

Returns

The name of the file.

bool File::remove_dependency

(

File *

file

)

Removes a dependency to another file if one such is found.

Parameters

file	The pointer to the File object which the dependency points to.

Returns

true if successfully removed, false if not found.

bool File::remove_dependent ( File *  file )

protected

A protected method that is called inside the remove_dependency method.

Parameters

file	The pointer to the File object which the dependency points to.

Returns

true if successfully removed, false if not found.

See Also

remove_dependency

---

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

• src/file.h
• src/file.cc