Skip to content

Commit

Permalink
Added outline for CatalogInfo class. Refs #7866.
Browse files Browse the repository at this point in the history
  • Loading branch information
jawrainey committed Oct 1, 2013
1 parent 4b5b88c commit 8f2e1da
Show file tree
Hide file tree
Showing 3 changed files with 147 additions and 0 deletions.
2 changes: 2 additions & 0 deletions Code/Mantid/Framework/Kernel/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ set ( SRC_FILES
src/ArrayProperty.cpp
src/Atom.cpp
src/BinFinder.cpp
src/CatalogInfo.cpp
src/CPUTimer.cpp
src/CompositeValidator.cpp
src/ConfigService.cpp
Expand Down Expand Up @@ -117,6 +118,7 @@ set ( INC_FILES
inc/MantidKernel/BinFinder.h
inc/MantidKernel/BinaryFile.h
inc/MantidKernel/BoundedValidator.h
inc/MantidKernel/CatalogInfo.h
inc/MantidKernel/CPUTimer.h
inc/MantidKernel/Cache.h
inc/MantidKernel/CompositeValidator.h
Expand Down
71 changes: 71 additions & 0 deletions Code/Mantid/Framework/Kernel/inc/MantidKernel/CatalogInfo.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
#ifndef MANTID_KERNEL_CATALOGINFO_H_
#define MANTID_KERNEL_CATALOGINFO_H_

//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidKernel/DllConfig.h"
#include "MantidKernel/Logger.h"

//----------------------------------------------------------------------
// Forward declarations
//----------------------------------------------------------------------
namespace Poco
{
namespace XML
{
class Element;
}
}

namespace Mantid
{
namespace Kernel
{

/** A class that holds information about a catalogs.
Copyright © 2007-2013 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://github.com/mantidproject/mantid>.
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/

class MANTID_KERNEL_DLL CatalogInfo
{
public:
/// Obtain catalog name from the facility file.
std::string catalogName(const Poco::XML::Element* element);
/// Obtain soap end point from the facility file.
std::string soapEndPoint(const Poco::XML::Element* element);
/// Obtain Windows prefix from the facility file.
std::string windowsPrefix(const Poco::XML::Element* element);
/// Obtain Macintosh prefix from facility file.
std::string macPrefix(const Poco::XML::Element* element);
/// Obtain Linux prefix from facility file.
std::string linuxPrefix(const Poco::XML::Element* element);
/// Transform's the archive path based on operating system used.
std::string transformArchivePath(std::string& path);
/// Replaces backward slash with forward slashes for Unix compatibility.
void replaceBackwardSlash(std::string& path);
};

} // namespace Kernel
} // namespace Mantid

#endif /* MANTID_KERNEL_CATALOGINFO_H_ */
74 changes: 74 additions & 0 deletions Code/Mantid/Framework/Kernel/src/CatalogInfo.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidKernel/CatalogInfo.h"

#include <Poco/DOM/Element.h>
#include <Poco/DOM/NodeList.h>

using Poco::XML::Element;

namespace Mantid
{
namespace Kernel
{
/**
* Obtain catalog name from the facility file.
*/
std::string CatalogInfo::catalogName(const Poco::XML::Element* element)
{

}

/**
* Obtain soap end point from the facility file.
*/
std::string CatalogInfo::soapEndPoint(const Poco::XML::Element* element)
{

}

/**
* Obtain Windows prefix from the facility file.
*/
std::string CatalogInfo::windowsPrefix(const Poco::XML::Element* element)
{

}

/**
* Obtain Macintosh prefix from facility file.
*/
std::string CatalogInfo::macPrefix(const Poco::XML::Element* element)
{

}

/**
* Obtain Linux prefix from facility file.
*/
std::string CatalogInfo::linuxPrefix(const Poco::XML::Element* element)
{

}

/**
* Transform's the archive path based on operating system used.
* @param path :: The archive path from ICAT to perform the transform on.
*/
std::string CatalogInfo::transformArchivePath(std::string& path)
{

}

/**
* Replace // with \\ for Unix compatibility.
* @param path :: The path to replace slashes on.
*/
void CatalogInfo::replaceBackwardSlash(std::string& path)
{

}

} // namespace Kernel
} // namespace Mantid

0 comments on commit 8f2e1da

Please sign in to comment.