OsDirLinux.h

Go to the documentation of this file.

//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$

#ifndef _OsDir_h_
#define _OsDir_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "os/OsStatus.h"
#include "os/OsDefs.h"
#include "os/OsFS.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class OsFileInfoBase;
class OsDirBase;
class OsPathLinux;
class OsFileInfoLinux;

//:Abstraction class to hande directory manipulations
class OsDirLinux : public OsDirBase
{

/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */


   OsDirLinux(const char* pathname);
   OsDirLinux(const OsPathLinux& rOsPath);

   OsDirLinux(const OsDirLinux& rOsDir);
     //:Copy constructor

   virtual
   ~OsDirLinux();
     //:Destructor

/* ============================ MANIPULATORS ============================== */

   OsStatus create(int permissions = 0755) const;
     //: Create the path specified by this object
     //  Returns OS_SUCCESS if successful, or OS_INVALID

   OsStatus rename(const char* name);
     //: Renames the current directory to the name specified
     //  Returns:
     //         OS_SUCCESS if successful
     //         OS_INVALID if failed

/* ============================ ACCESSORS ================================= */

   OsStatus getFileInfo(OsFileInfoBase& rFileInfo) const;
     //: Returns the file information for this objects path (see 
     //:        OsFileInfo for more detail)
     //  Returns: 
     //         OS_SUCCESS if successful
     //         OS_INVALID if failed

/* ============================ INQUIRY =================================== */

   UtlBoolean exists();
     //: Returns TRUE if the directory specified by this object exists

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
   OsDirLinux();
     //:Default constructor

   OsDirLinux& operator=(const OsDirLinux& rhs);
     //:Assignment operator

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
    

};

/* ============================ INLINE METHODS ============================ */

#endif  // _OsDir_h_