Mantid
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Member Functions | List of all members
Mantid::Geometry::AbstractIDFObject Class Referenceabstract

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

#include <IDFObject.h>

Inheritance diagram for Mantid::Geometry::AbstractIDFObject:
Mantid::Geometry::IDFObject Mantid::Geometry::NullIDFObject

Public Member Functions

 AbstractIDFObject ()=default
 
virtual bool exists () const =0
 
virtual std::string getExtension () const =0
 
virtual const Poco::Path & getFileFullPath () const =0
 
virtual const std::string & getFileFullPathStr () const =0
 
virtual std::string getFileNameOnly () const =0
 
virtual std::string getMangledName () const =0
 
virtual const Poco::Path getParentDirectory () const =0
 
virtual ~AbstractIDFObject ()=default
 

Static Public Member Functions

static const std::string expectedExtension ()
 Returns the expected extension of an IDF file. More...
 

Private Member Functions

 AbstractIDFObject (const AbstractIDFObject &)
 
AbstractIDFObjectoperator= (const AbstractIDFObject &)
 

Detailed Description

IDFObject : File object wrapper over an IDF file.

This is essentially an adapter for a Poco::File, with some extra convenience methods allowing easy access to the parent directory path. This type has the last modified date and the exists method as a virtual methods to facilite testing. Abstract IDF Object

Definition at line 31 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

◆ 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 18 of file IDFObject.cpp.

◆ getExtension()

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

◆ getFileFullPath()

virtual const Poco::Path & Mantid::Geometry::AbstractIDFObject::getFileFullPath ( ) const
pure virtual

◆ getFileFullPathStr()

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

◆ getFileNameOnly()

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

◆ getMangledName()

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

◆ getParentDirectory()

virtual const Poco::Path Mantid::Geometry::AbstractIDFObject::getParentDirectory ( ) const
pure virtual

◆ operator=()

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

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