FileManager.hpp

Go to the documentation of this file.

// ======================================================================
// \title  FileManager.hpp
// \author bocchino
// \brief  hpp file for FileManager component implementation class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================
 
#ifndef Svc_FileManager_HPP
#define Svc_FileManager_HPP
 
#include "Svc/FileManager/FileManagerComponentAc.hpp"
#include "Os/FileSystem.hpp"
 
namespace Svc {
 
  class FileManager :
    public FileManagerComponentBase
  {
 
    public:
 
      // ----------------------------------------------------------------------
      // Construction, initialization, and destruction
      // ----------------------------------------------------------------------
 
      FileManager(
          const char *const compName 
      );
 
      void init(
          const NATIVE_INT_TYPE queueDepth, 
          const NATIVE_INT_TYPE instance 
      );
 
      ~FileManager();
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Command handler implementations
      // ----------------------------------------------------------------------
 
      void CreateDirectory_cmdHandler(
          const FwOpcodeType opCode, 
          const U32 cmdSeq, 
          const Fw::CmdStringArg& dirName 
      );
 
      void RemoveFile_cmdHandler(
          const FwOpcodeType opCode, 
          const U32 cmdSeq, 
          const Fw::CmdStringArg& fileName, 
          const bool ignoreErrors 
      );
 
      void MoveFile_cmdHandler(
          const FwOpcodeType opCode, 
          const U32 cmdSeq, 
          const Fw::CmdStringArg& sourceFileName, 
          const Fw::CmdStringArg& destFileName 
      );
 
      void RemoveDirectory_cmdHandler(
          const FwOpcodeType opCode, 
          const U32 cmdSeq, 
          const Fw::CmdStringArg& dirName 
      );
 
      void ShellCommand_cmdHandler(
          const FwOpcodeType opCode, 
          const U32 cmdSeq, 
          const Fw::CmdStringArg& command, 
          const Fw::CmdStringArg& logFileName 
      );
 
      void AppendFile_cmdHandler(
          const FwOpcodeType opCode, 
          const U32 cmdSeq, 
          const Fw::CmdStringArg& source, 
          const Fw::CmdStringArg& target 
      );
 
      void FileSize_cmdHandler(
          const FwOpcodeType opCode, 
          const U32 cmdSeq, 
          const Fw::CmdStringArg& fileName 
      );
 
      void pingIn_handler(
          const NATIVE_INT_TYPE portNum, 
          U32 key 
      );
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Helper methods
      // ----------------------------------------------------------------------
 
      NATIVE_INT_TYPE systemCall(
          const Fw::CmdStringArg& command, 
          const Fw::CmdStringArg& logFileName 
      ) const;
 
      void emitTelemetry(
          const Os::FileSystem::Status status 
      );
 
      void sendCommandResponse(
          const FwOpcodeType opCode, 
          const U32 cmdSeq, 
          const Os::FileSystem::Status status 
      );
 
    PRIVATE:
 
      // ----------------------------------------------------------------------
      // Variables
      // ----------------------------------------------------------------------
 
      U32 commandCount;
 
      U32 errorCount;
 
 
  };
 
} // end namespace Svc
 
#endif