SH::DiskList Class Reference

an interface for listing directory contents, locally or on a file server More...

#include <DiskList.h>

Inheritance diagram for SH::DiskList:

Collaboration diagram for SH::DiskList:

Public Member Functions
void	testInvariant () const
	test the invariant of this object
virtual	~DiskList ()
	standard destructor
bool	next ()
	get the next list entry
std::string	path () const
	the path for the current entry.
std::string	fileName () const
	the filename for the current entry
DiskList *	openDir () const
	make a new list object for the sub-directory
std::string	dirname () const
	the base path for the directory listed

Protected Member Functions
	DiskList ()
	standard constructor
virtual bool	getNext ()=0
	get the next list entry
virtual std::string	getPath () const =0
	the path for the current entry.
virtual DiskList *	doOpenDir () const =0
	make a new list object for the sub-directory
virtual std::string	getDirname () const =0
	the base path for the directory listed

Private Types
enum	State { S_BLANK , S_VALID , S_DONE , S_BROKEN }
	the current state More...

Private Attributes
State	m_state
	the current state

Detailed Description

an interface for listing directory contents, locally or on a file server

Rationale:

this interface was introduced to allow the various data discovery methods to work with the various kinds of file servers without having to specialize them all individually.

Definition at line 31 of file DiskList.h.

Member Enumeration Documentation

State

enum SH::DiskList::State

private

the current state

Enumerator
S_BLANK	just initialized
S_VALID	holding a valid entry
S_DONE	finished reading entries
S_BROKEN	an error occured

Definition at line 166 of file DiskList.h.

    {
      S_BLANK,  
      S_VALID,  
      S_DONE,   
      S_BROKEN  
    };

Constructor & Destructor Documentation

~DiskList()

SH::DiskList::~DiskList ( )

virtual

standard destructor

Guarantee

no-fail

Rationale

virtual destructor for base class

Definition at line 36 of file DiskList.cxx.

  {
    RCU_DESTROY_INVARIANT (this);
  }

DiskList()

SH::DiskList::DiskList ( )

protected

standard constructor

Guarantee

strong

Failures

out of memory I

Definition at line 44 of file DiskList.cxx.

    : m_state (S_BLANK)
  {
    RCU_NEW_INVARIANT (this);
  }

Member Function Documentation

dirname()

std::string SH::DiskList::dirname

(

)

const

the base path for the directory listed

Guarantee

strong

Failures

out of memory II

Definition at line 110 of file DiskList.cxx.

  {
    RCU_READ_INVARIANT (this);
    return getDirname ();
  }

doOpenDir()

virtual DiskList * SH::DiskList::doOpenDir ( ) const

protectedpure virtual

make a new list object for the sub-directory

Returns

a new list object for the sub-directory, or NULL if it is not a directory

Precondition

(soft) next() has been called successfully

Guarantee

strong

Failures

out of memory III

Rationale

the virtual part of DiskList::openDir()

Implemented in SH::DiskListEOS, SH::DiskListLocal, SH::DiskListSRM, and SH::DiskListXRD.

fileName()

std::string SH::DiskList::fileName

(

)

const

the filename for the current entry

Returns

the filename for the current entry

Precondition

(soft) next() has been called successfully

Guarantee

strong

Failures

out of memory III

Definition at line 87 of file DiskList.cxx.

  {
    // no invariant used
    std::string result = path();
    std::string::size_type split = result.rfind ('/');
    if (split != std::string::npos)
      result = result.substr (split + 1);
    return result;
  }

getDirname()

virtual std::string SH::DiskList::getDirname ( ) const

protectedpure virtual

the base path for the directory listed

Guarantee

strong

Failures

out of memory II

Rationale

the virtual part of DiskList::dirname()

Implemented in SH::DiskListEOS, SH::DiskListLocal, SH::DiskListSRM, and SH::DiskListXRD.

getNext()

virtual bool SH::DiskList::getNext ( )

protectedpure virtual

get the next list entry

Returns

whether we found another entry

Guarantee

basic

Failures

i/o errors

Rationale

the virtual part of DiskList::next()

Implemented in SH::DiskListEOS, SH::DiskListLocal, SH::DiskListSRM, and SH::DiskListXRD.

getPath()

virtual std::string SH::DiskList::getPath ( ) const

protectedpure virtual

the path for the current entry.

Returns

the path for the current entry

Precondition

(soft) next() has been called successfully

Guarantee

strong failures: out of memory III

Rationale

the virtual part of DiskList::path()

Implemented in SH::DiskListEOS, SH::DiskListLocal, SH::DiskListSRM, and SH::DiskListXRD.

next()

bool SH::DiskList::next

(

)

get the next list entry

Returns

whether we found another entry

Guarantee

basic

Failures

i/o errors

Definition at line 53 of file DiskList.cxx.

  {
    RCU_CHANGE_INVARIANT (this);
    switch (m_state)
    {
    case S_BLANK:
    case S_VALID:
      m_state = S_BROKEN;
      if (getNext())
    m_state = S_VALID;
      else
    m_state = S_DONE;
      return m_state == S_VALID;
    case S_DONE:
      RCU_THROW_MSG ("already finished processing list");
    case S_BROKEN:
      RCU_THROW_MSG ("list is in error state");
    };
    return false; // compiler dummy
  }

openDir()

DiskList * SH::DiskList::openDir

(

)

const

make a new list object for the sub-directory

Returns

a new list object for the sub-directory, or NULL if it is not a directory

Precondition

(soft) next() has been called successfully

Guarantee

strong

Failures

out of memory III

Definition at line 100 of file DiskList.cxx.

  {
    RCU_READ_INVARIANT (this);
    RCU_REQUIRE2_SOFT (m_state == S_VALID, "getNext() has not been called successfully");
    return doOpenDir();
  }

path()

std::string SH::DiskList::path

(

)

const

the path for the current entry.

Returns

the path for the current entry

Precondition

(soft) next() has been called successfully

Guarantee

strong failures: out of memory III

Definition at line 77 of file DiskList.cxx.

  {
    RCU_READ_INVARIANT (this);
    RCU_REQUIRE2_SOFT (m_state == S_VALID, "getNext() has not been called successfully");
    return getPath();
  }

testInvariant()

void SH::DiskList::testInvariant

(

)

const

test the invariant of this object

Guarantee

no-fail

Definition at line 29 of file DiskList.cxx.

  {
    RCU_INVARIANT (m_state <= S_BROKEN);
  }

Member Data Documentation

m_state

State SH::DiskList::m_state

private

the current state

Definition at line 174 of file DiskList.h.

---

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

• DiskList.h
• DiskList.cxx