Guiliani  Version 2.6 revision 7293 (documentation build 12)
CGUIDirInfoPOSIX Class Reference

Implementation of the CGUIDirInfo for *NIX systems. More...

#include <GUIDirInfoPOSIX.h>

Inheritance diagram for CGUIDirInfoPOSIX:

Public Member Functions

 ~CGUIDirInfoPOSIX ()
 
virtual eC_Bool CheckExist () const
 
virtual eC_UInt GetGroupID () const
 
virtual eC_String GetGroupName () const
 
virtual eC_UInt GetOwnerID () const
 
virtual eC_String GetOwnerName () const
 
virtual long long int GetSize () const
 
virtual GUIFileTime_t GetTimeCreated () const
 
virtual GUIFileTime_t GetTimeLatestModified () const
 
virtual GUIFileTime_t GetTimeLatestRead () const
 
virtual eC_Bool IsDir () const
 
virtual eC_Bool IsExecutable () const
 
virtual eC_Bool IsFile () const
 
virtual eC_Bool IsHidden () const
 
virtual eC_Bool IsReadable () const
 
virtual eC_Bool IsRoot () const
 
virtual eC_Bool IsSymLink () const
 
virtual eC_Bool IsSystem () const
 
virtual eC_Bool IsWritable () const
 
virtual eC_String ReadLink () const
 
- Public Member Functions inherited from CGUIDirInfo
 CGUIDirInfo ()
 
 CGUIDirInfo (const CGUIDirInfo &kDirInfo)
 
 CGUIDirInfo (const eC_String &kFileName, const eC_String &kCurrentWorkingDirPath)
 
virtual ~CGUIDirInfo ()
 
void ChangeFilePath (const eC_String &kNewFilePath)
 
virtual eC_Bool CheckExist () const =0
 
eC_String GetAbsPath () const
 
eC_String GetAbsPath_File () const
 
eC_String GetFileBaseName () const
 
eC_String GetFileName () const
 
eC_String GetFileSuffix () const
 
virtual eC_UInt GetGroupID () const =0
 
virtual eC_String GetGroupName () const =0
 
virtual eC_UInt GetOwnerID () const =0
 
virtual eC_String GetOwnerName () const =0
 
eC_String GetPath () const
 
eC_String GetPath_File () const
 
virtual long long int GetSize () const =0
 
virtual GUIFileTime_t GetTimeCreated () const =0
 
virtual GUIFileTime_t GetTimeLatestModified () const =0
 
virtual GUIFileTime_t GetTimeLatestRead () const =0
 
virtual eC_Bool IsAbsPath () const
 
virtual eC_Bool IsDir () const =0
 
virtual eC_Bool IsExecutable () const =0
 
virtual eC_Bool IsFile () const =0
 
virtual eC_Bool IsHidden () const =0
 
virtual eC_Bool IsReadable () const =0
 
virtual eC_Bool IsRoot () const =0
 
virtual eC_Bool IsSymLink () const =0
 
virtual eC_Bool IsSystem () const =0
 
virtual eC_Bool IsWritable () const =0
 
void MakePathAbs ()
 
CGUIDirInfooperator= (const CGUIDirInfo &kDirInfo)
 
virtual eC_String ReadLink () const =0
 

Protected Member Functions

virtual GUIFileTime_t GetTime (FileTime_t eFileTime) const
 
virtual GUIFileTime_t GetTime (FileTime_t eFileTime) const =0
 

Friends

class CGUIDirectoryPOSIX
 Only the CGUIFileSysWrapPOSIX and CGUIDirectoryPOSIX can construct an object of this class.
 
class CGUIFileSysWrapPOSIX
 Only the CGUIFileSysWrapPOSIX and CGUIDirectoryPOSIX can construct an object of this class.
 

Additional Inherited Members

- Public Types inherited from CGUIDirInfo
typedef eC_TListDoubleLinked< CGUIDirInfo * > DirInfoPtrList_t
 Type define for the CGUIDirInfo list.
 
- Static Public Attributes inherited from CGUIDirInfo
static const eC_UInt ID_UNKNOWN = static_cast<eC_UInt>(-1)
 Value used as "unknown" ID.
 
- Protected Types inherited from CGUIDirInfo
enum  FileTime_t { CreatedTime , ModifiedTime , ReadTime }
 
- Protected Attributes inherited from CGUIDirInfo
eC_String m_kCurrentWorkingDirPath
 
eC_String m_kFilePath
 

Detailed Description

Implementation of the CGUIDirInfo for *NIX systems.

Constructor & Destructor Documentation

◆ ~CGUIDirInfoPOSIX()

CGUIDirInfoPOSIX::~CGUIDirInfoPOSIX ( )
inline

Destructor.

Member Function Documentation

◆ CheckExist()

virtual eC_Bool CGUIDirInfoPOSIX::CheckExist ( ) const
virtual

Check whether the file does exist in the file system.

Returns
True if the file does exist, otherwise False.

Implements CGUIDirInfo.

◆ GetGroupID()

virtual eC_UInt CGUIDirInfoPOSIX::GetGroupID ( ) const
virtual

Get the group ID of this file.

Returns
The group ID of this file.

Implements CGUIDirInfo.

◆ GetGroupName()

virtual eC_String CGUIDirInfoPOSIX::GetGroupName ( ) const
virtual

Get the group name of this file.

Returns
The group name of this file.

Implements CGUIDirInfo.

◆ GetOwnerID()

virtual eC_UInt CGUIDirInfoPOSIX::GetOwnerID ( ) const
virtual

Get the owner ID of the file.

Returns
the owner ID of the file.

Implements CGUIDirInfo.

◆ GetOwnerName()

virtual eC_String CGUIDirInfoPOSIX::GetOwnerName ( ) const
virtual

Get the owner name of the file.

Returns
The owner name of the file.

Implements CGUIDirInfo.

◆ GetSize()

virtual long long int CGUIDirInfoPOSIX::GetSize ( ) const
virtual

Get the size of the file.

Returns
The size of the file.

Implements CGUIDirInfo.

◆ GetTime()

virtual GUIFileTime_t CGUIDirInfoPOSIX::GetTime ( FileTime_t  eFileTime) const
protectedvirtual

Get the time according to the given file time type.

Parameters
eFileTimeThe file time type, i.e. Created, LatestModifed or LatestRead.
Returns
Time obtained.

Implements CGUIDirInfo.

◆ GetTimeCreated()

virtual GUIFileTime_t CGUIDirInfoPOSIX::GetTimeCreated ( ) const
virtual

Get the time when the file was created.

Returns
The time when the file was created.

Implements CGUIDirInfo.

◆ GetTimeLatestModified()

virtual GUIFileTime_t CGUIDirInfoPOSIX::GetTimeLatestModified ( ) const
virtual

Get the time when the file was modified last time.

Returns
The time when the file was modified last time.

Implements CGUIDirInfo.

◆ GetTimeLatestRead()

virtual GUIFileTime_t CGUIDirInfoPOSIX::GetTimeLatestRead ( ) const
virtual

Get the time when the file was read last time.

Returns
The time when the file was read last time.

Implements CGUIDirInfo.

◆ IsDir()

virtual eC_Bool CGUIDirInfoPOSIX::IsDir ( ) const
virtual

Check whether the file is a directory.

Returns
True if it is a directory, otherwise False.

Implements CGUIDirInfo.

◆ IsExecutable()

virtual eC_Bool CGUIDirInfoPOSIX::IsExecutable ( ) const
virtual

Check whether the file is executable or not.

Returns
True if the file is excutable, otherwise False.

Implements CGUIDirInfo.

◆ IsFile()

virtual eC_Bool CGUIDirInfoPOSIX::IsFile ( ) const
virtual

Check whether the file is a file (not a directory).

Returns
True if it is a file, otherwise False.

Implements CGUIDirInfo.

◆ IsHidden()

virtual eC_Bool CGUIDirInfoPOSIX::IsHidden ( ) const
virtual

Check whether the file is a hidden file.

Returns
True if it is a hidden file, otherwise False.

Implements CGUIDirInfo.

◆ IsReadable()

virtual eC_Bool CGUIDirInfoPOSIX::IsReadable ( ) const
virtual

Check whether the file is readable or not.

Returns
True if the file is readable, otherwise False.

Implements CGUIDirInfo.

◆ IsRoot()

virtual eC_Bool CGUIDirInfoPOSIX::IsRoot ( ) const
virtual

Check whether the given file is a root directory or not.

Returns
True if the directory is the root directory; otherwise False.

Implements CGUIDirInfo.

◆ IsSymLink()

virtual eC_Bool CGUIDirInfoPOSIX::IsSymLink ( ) const
virtual

Check whether the file is a symlink.

Returns
True if it is a symlink, otherwise False.

Implements CGUIDirInfo.

◆ IsSystem()

virtual eC_Bool CGUIDirInfoPOSIX::IsSystem ( ) const
virtual

Check whether the file is a system file. Means that the file is a FIFO, socket or device file.

Returns
True if it is a hidden file, otherwise False.

Implements CGUIDirInfo.

◆ IsWritable()

virtual eC_Bool CGUIDirInfoPOSIX::IsWritable ( ) const
virtual

Check whether the file is writable or not.

Returns
True if the file is writable, otherwise False.

Implements CGUIDirInfo.

◆ ReadLink()

virtual eC_String CGUIDirInfoPOSIX::ReadLink ( ) const
virtual

Get the name a symlink points to, or a an empty string if the object isn't a symbolic link.

Returns
The file name that the symlink points to.

Implements CGUIDirInfo.


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