This class holds a file. More...

Inheritance diagram for Ocean::IO::File:

Public Member Functions
	File ()
	Creates an empty file. More...

	File (const std::string &filename)
	Create a new file. More...

bool	isValid () const override
	Returns whether the path is valid. More...

bool	exists () const override
	Returns whether the file exists already. More...

bool	remove () const
	Removes this file from the filesystem. More...

std::string	base () const
	Returns the base of this file. More...

std::string	extension () const
	Returns the extension of this file. More...

std::string	name () const
	Returns the name of this file. More...

std::string	baseName () const
	Returns the base name of this file. More...

Public Member Functions inherited from Ocean::IO::Path
virtual	~Path ()=default
	Destructs a path. More...

Type	type () const
	Returns the type of this path. More...

bool	isAbsolute () const
	Returns whether this path is absolute. More...

bool	isRelative () const
	Returns whether this path is relative. More...

bool	isNull () const
	Returns whether this path holds no valid. More...

bool	operator== (const Path &right) const
	Returns whether two paths are equal. More...

bool	operator!= (const Path &path) const
	Returns whether two paths are not equal. More...

const std::string &	operator() () const
	Returns the value of this path. More...

bool	operator< (const Path &path) const
	Less operator comparing the actual strings of two paths. More...

Static Public Member Functions
static bool	existsApple (const std::string &file)
	Returns whether a file exists (specialization for Apple platforms). More...

Static Public Member Functions inherited from Ocean::IO::Path
static bool	isSeparator (const char character)
	Returns whether a given character is a separator. More...

static char	defaultSeparator ()
	Returns the default separator of a path. More...

Additional Inherited Members
Public Types inherited from Ocean::IO::Path
enum	Type { TYPE_INVALID = 0 , TYPE_FILE = 1 , TYPE_DIRECTORY = 2 , TYPE_ABSOLUTE = 4 , TYPE_RELATIVE = 8 , TYPE_NETWORK = 16 }
	Definition of different path types. More...

enum	Separator { SEPARATOR_UNDEFINED = 0 , SEPARATOR_SLASH = '/' , SEPARATOR_BACKSLASH = '\\' }
	Definition of path separators. More...

Protected Member Functions inherited from Ocean::IO::Path
	Path ()=default
	Creates a new undefined path. More...

	Path (const Path &path)=default
	Copy constructor. More...

	Path (const std::string &value)
	Creates a new path. More...

void	checkPath (const Type expectType)
	Checks the type of this path and trims it. More...

void	trim ()
	Trims this path. More...

Path &	operator= (const Path &path)=default
	Default assign operator. More...

Protected Attributes inherited from Ocean::IO::Path
Type	pathType_ = TYPE_INVALID
	Path type. More...

std::string	pathValue_
	Path value. More...

Detailed Description

This class holds a file.

Constructor & Destructor Documentation

◆ File() [1/2]

Ocean::IO::File::File ( )

Creates an empty file.

◆ File() [2/2]

Ocean::IO::File::File ( const std::string & filename )

explicit

Create a new file.

Parameters

filename File name

Member Function Documentation

◆ base()

std::string Ocean::IO::File::base ( ) const

Returns the base of this file.

The file's base is the entire file path without file extension (and the character in front of the extension).
The base of e.g. "example.bmp" is "example"; "/first/second/example.txt" is "/first/second/example"

Returns: File base

◆ baseName()

std::string Ocean::IO::File::baseName ( ) const

Returns the base name of this file.

The base name is the local filename without extension.
The base name of e.g. "example.bmp" is "example"; "/first/second/example.txt" is "example"

Returns: File base name

◆ exists()

bool Ocean::IO::File::exists ( ) const

overridevirtual

Returns whether the file exists already.

See also: Path::exists(), remove().

Implements Ocean::IO::Path.

◆ existsApple()

static bool Ocean::IO::File::existsApple ( const std::string & file )

static

Returns whether a file exists (specialization for Apple platforms).

Parameters

file	The file to check

Returns: True, if so

◆ extension()

std::string Ocean::IO::File::extension ( ) const

Returns the extension of this file.

The file's extension of e.g. "example.bmp" is "bmp".

Returns: File extension

◆ isValid()

bool Ocean::IO::File::isValid ( ) const

overridevirtual

Returns whether the path is valid.

See also: Path::isValid();

Implements Ocean::IO::Path.

◆ name()

std::string Ocean::IO::File::name ( ) const

Returns the name of this file.

The file's name is the local filename including the file extension without the prefix path.
The name of e.g. "example.bmp" is "example.bmp"; "/first/second/example.txt" is "example.txt"

Returns: File name

◆ remove()

bool Ocean::IO::File::remove ( ) const

Removes this file from the filesystem.

Returns: True, if succeeded

See also: exists().

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

File.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members