OSDirectory.hxx

Go to the documentation of this file.

/*==================================================================================================
  
Copyright (c) 2013 Siemens PLM
Unpublished - All rights reserved

 ====================================================================================================*/
#ifndef FCLASSES_OSDIRECTORY_INCLUDE_HXX
#define FCLASSES_OSDIRECTORY_INCLUDE_HXX

#include <vector>
#include <ss/ss_types.h>
#include <fclasses/OSFile.hxx>

#include <fclasses/libfclasses_exports.h>
namespace Teamcenter
{
    class FCLASSES_API OSDirectory
    {
    public:
        enum OSType {
            TCSERVER_OS = 0, 
            UNIX_OS,         
            WINDOWS_OS       
        };

        OSDirectory(const char *iDirectoryPath, OSType iOSType=TCSERVER_OS);
        
        OSDirectory(const OSDirectory&);

        OSDirectory(OSType iOSType=TCSERVER_OS);

        virtual ~OSDirectory();

        OSDirectory& operator = (const OSDirectory&);

        static char* getLeafName( const char* iDirectoryPath, OSType iOSType=TCSERVER_OS );

        char* getLeafName() const;

        static char *mergePaths(const char *iDirectoryPath, const char *iSubPath, OSType iOSType=TCSERVER_OS);
        
        static char* generateUniqueName(const char* iPrefix = 0);       

        static char* getCurrentWorkDirectory();
        

        char *getDirectoryPath() const;


        int exists(bool& oDirectoryExists) const;


        int create (int iMode = SS_DEF_DMODE);

        int chmod(int iMode);

        int setCurrentWorkDirectory(const char *iDirectoryPath);

        int deleteDirectory();

        int open();

        int close();


        int readDirectory(SS_file_status *ioStatus);
        
        int readDirectoryWithoutFormatData(SS_file_status *ioStatus);

        int copyDirectory (const char *iDestinationPath);
        
        int wipeOut(bool iDeleteOnlyIfEmpty=false);


        int listSubDirectories( std::vector<OSDirectory>& oListDirectories );


        int listFiles( std::vector<Teamcenter::OSFile>& oListFiles );


        int listContent( std::vector<OSDirectory>& oListDirectories, std::vector<Teamcenter::OSFile>& oListFiles );


        virtual char *asString() const;


    private:
        int listContent(std::vector<OSDirectory>& oListDirectories, std::vector<Teamcenter::OSFile>& oListFiles, int file_format);

        OSType          m_osType;

        char*           m_directoryPath;

        SS_dir          m_directoryDescriptor;

        struct
        {
            int error_status;
            const char* operation;
        } m_directoryStatus;

        static const char* OPERATION_CONSTRUCTOR;
        static const char* OPERATION_COPYCONST;
        static const char* OPERATION_OPERATOREQUALS;
        static const char* OPERATION_CREATE;
        static const char* OPERATION_OPEN;
        static const char* OPERATION_CLOSE;
        static const char* OPERATION_DELETEDIR;
        static const char* OPERATION_EXISTS;
        static const char* OPERATION_CHMOD;
        static const char* OPERATION_SETDIRPATH;
        static const char* OPERATION_READ;
    };
}
#include <fclasses/libfclasses_undef.h>
#endif