Mantid::Geometry::AbstractIDFObject Class Reference

IDFObject : File object wrapper over an IDF file. More...

#include <IDFObject.h>

Inheritance diagram for Mantid::Geometry::AbstractIDFObject:

Public Member Functions
	AbstractIDFObject ()=default
virtual bool	exists () const =0
virtual std::string	getExtension () const =0
virtual const std::filesystem::path &	getFileFullPath () const =0
virtual const std::string &	getFileFullPathStr () const =0
virtual std::string	getFileNameOnly () const =0
virtual std::string	getMangledName () const =0
virtual std::filesystem::path	getParentDirectory () const =0
virtual	~AbstractIDFObject ()=default

Static Public Member Functions
static const std::string	expectedExtension ()
	Returns the expected extension of an IDF file.

Private Member Functions
	AbstractIDFObject (const AbstractIDFObject &)
AbstractIDFObject &	operator= (const AbstractIDFObject &)

Detailed Description

IDFObject : File object wrapper over an IDF file.

This is essentially a file path wrapper with some extra convenience methods allowing easy access to the parent directory path. This type has the exists method as a virtual method to facilitate testing. Abstract IDF Object

Definition at line 29 of file IDFObject.h.

Constructor & Destructor Documentation

AbstractIDFObject() [1/2]

Mantid::Geometry::AbstractIDFObject::AbstractIDFObject ( )

default

~AbstractIDFObject()

virtual Mantid::Geometry::AbstractIDFObject::~AbstractIDFObject ( )

virtualdefault

AbstractIDFObject() [2/2]

Mantid::Geometry::AbstractIDFObject::AbstractIDFObject ( const AbstractIDFObject &  )

private

Member Function Documentation

exists()

virtual bool Mantid::Geometry::AbstractIDFObject::exists ( ) const

pure virtual

Implemented in Mantid::Geometry::IDFObject, and Mantid::Geometry::NullIDFObject.

expectedExtension()

const std::string Mantid::Geometry::AbstractIDFObject::expectedExtension ( )

static

Returns the expected extension of an IDF file.

Returns

A string containing the expected extension of an IDF file, including the leading period (.)

Definition at line 20 of file IDFObject.cpp.

getExtension()

virtual std::string Mantid::Geometry::AbstractIDFObject::getExtension ( ) const

pure virtual

Implemented in Mantid::Geometry::IDFObject, and Mantid::Geometry::NullIDFObject.

getFileFullPath()

virtual const std::filesystem::path & Mantid::Geometry::AbstractIDFObject::getFileFullPath ( ) const

pure virtual

Implemented in Mantid::Geometry::IDFObject, and Mantid::Geometry::NullIDFObject.

getFileFullPathStr()

virtual const std::string & Mantid::Geometry::AbstractIDFObject::getFileFullPathStr ( ) const

pure virtual

Implemented in Mantid::Geometry::IDFObject, and Mantid::Geometry::NullIDFObject.

getFileNameOnly()

virtual std::string Mantid::Geometry::AbstractIDFObject::getFileNameOnly ( ) const

pure virtual

Implemented in Mantid::Geometry::IDFObject, and Mantid::Geometry::NullIDFObject.

getMangledName()

virtual std::string Mantid::Geometry::AbstractIDFObject::getMangledName ( ) const

pure virtual

Implemented in Mantid::Geometry::IDFObject, and Mantid::Geometry::NullIDFObject.

getParentDirectory()

virtual std::filesystem::path Mantid::Geometry::AbstractIDFObject::getParentDirectory ( ) const

pure virtual

Implemented in Mantid::Geometry::IDFObject, and Mantid::Geometry::NullIDFObject.

operator=()

AbstractIDFObject & Mantid::Geometry::AbstractIDFObject::operator= ( const AbstractIDFObject &  )

private

---

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

• Framework/Geometry/inc/MantidGeometry/Instrument/IDFObject.h
• Framework/Geometry/src/Instrument/IDFObject.cpp