ossimRpfFrameEntry Class Reference

#include <ossimRpfFrameEntry.h>

Public Member Functions
	ossimRpfFrameEntry (const ossimFilename &rootDirectory=ossimFilename(""), const ossimFilename &pathToFrameFileFromRoot=ossimFilename(""))
	ossimRpfFrameEntry (const ossimRpfFrameEntry &obj)
	copy constructor More...
const ossimRpfFrameEntry &	operator= (const ossimRpfFrameEntry &rhs)
	operator= More...
std::ostream &	print (std::ostream &out, const std::string &prefix=std::string()) const
	print method that outputs a key/value type format adding prefix to keys. More...
bool	exists () const
void	setEntry (const ossimFilename &rootDirectory, const ossimFilename &pathToFrameFileFromRoot)
const ossimFilename &	getFullPath () const
const ossimString &	getRootDirectory () const
const ossimString	getPathToFrameFileFromRoot () const

Private Attributes
bool	m_exists
ossimFilename	m_rootDirectory
ossimFilename	m_pathToFrameFileFromRoot
ossimFilename	m_fullValidPath

Friends
std::ostream &	operator<< (std::ostream &out, const ossimRpfFrameEntry &data)

Detailed Description

Definition at line 19 of file ossimRpfFrameEntry.h.

Constructor & Destructor Documentation

ossimRpfFrameEntry() [1/2]

ossimRpfFrameEntry::ossimRpfFrameEntry	(	const ossimFilename &	rootDirectory = ossimFilename(""),
		const ossimFilename &	pathToFrameFileFromRoot = ossimFilename("")
	)

Definition at line 22 of file ossimRpfFrameEntry.cpp.

References setEntry().

   :m_exists(false),
    m_rootDirectory(rootDirectory),
    m_pathToFrameFileFromRoot(pathToFrameFileFromRoot),
    m_fullValidPath()
{
   setEntry(rootDirectory,
            pathToFrameFileFromRoot);
}

ossimRpfFrameEntry() [2/2]

ossimRpfFrameEntry::ossimRpfFrameEntry

(

const ossimRpfFrameEntry &

obj

)

copy constructor

Definition at line 33 of file ossimRpfFrameEntry.cpp.

   :m_exists(obj.m_exists),
    m_rootDirectory(obj.m_rootDirectory),
    m_pathToFrameFileFromRoot(obj.m_pathToFrameFileFromRoot),
    m_fullValidPath(obj.m_fullValidPath)
{}

Member Function Documentation

exists()

bool ossimRpfFrameEntry::exists

(

)

const

Definition at line 107 of file ossimRpfFrameEntry.cpp.

References m_exists.

Referenced by ossimRpfToc::getFirstEntry(), ossimImageCacheBase::getIntersectingEntries(), and ossimRpfCacheTileSource::getIntersectingEntries().

{
   return m_exists;
}

getFullPath()

const ossimFilename & ossimRpfFrameEntry::getFullPath

(

)

const

Definition at line 112 of file ossimRpfFrameEntry.cpp.

References m_fullValidPath.

Referenced by ossimCibCadrgTileSource::populateLut(), and ossimCibCadrgTileSource::updatePropertiesToFirstValidFrame().

{
   return m_fullValidPath;
}

getPathToFrameFileFromRoot()

const ossimString ossimRpfFrameEntry::getPathToFrameFileFromRoot

(

)

const

Definition at line 122 of file ossimRpfFrameEntry.cpp.

References m_pathToFrameFileFromRoot.

Referenced by ossimRpfToc::getRelativeFramePath().

{
   return m_pathToFrameFileFromRoot;
}

getRootDirectory()

const ossimString & ossimRpfFrameEntry::getRootDirectory

(

)

const

Definition at line 117 of file ossimRpfFrameEntry.cpp.

References m_rootDirectory.

{
   return m_rootDirectory;
}

operator=()

const ossimRpfFrameEntry & ossimRpfFrameEntry::operator=

(

const ossimRpfFrameEntry &

rhs

)

operator=

Definition at line 40 of file ossimRpfFrameEntry.cpp.

References m_exists, m_fullValidPath, m_pathToFrameFileFromRoot, and m_rootDirectory.

{
   if (this != &rhs)
   {
      m_exists                  = rhs.m_exists;
      m_rootDirectory           = rhs.m_rootDirectory;
      m_pathToFrameFileFromRoot = rhs.m_pathToFrameFileFromRoot;
      m_fullValidPath           = rhs.m_fullValidPath;
   }
   return *this;
}

print()

std::ostream & ossimRpfFrameEntry::print	(	std::ostream &	out,
		const std::string &	prefix = std::string()
	)		const

print method that outputs a key/value type format adding prefix to keys.

Parameters

out	String to output to.
prefix	This will be prepended to key. e.g. Where prefix = "nitf." and key is "file_name" key becomes: "nitf.file_name:"

Returns

output stream.

Definition at line 95 of file ossimRpfFrameEntry.cpp.

References m_exists, m_fullValidPath, m_pathToFrameFileFromRoot, and m_rootDirectory.

Referenced by operator<<().

{
   out << prefix << "exists:       " << m_exists << "\n"
       << prefix << "root_directory: " << m_rootDirectory << "\n"
       << prefix << "relative_path: "
       << m_pathToFrameFileFromRoot << "\n"
       << prefix << "full_path:     " << m_fullValidPath << "\n";

   return out;
}

setEntry()

void ossimRpfFrameEntry::setEntry	(	const ossimFilename &	rootDirectory,
		const ossimFilename &	pathToFrameFileFromRoot
	)

Definition at line 52 of file ossimRpfFrameEntry.cpp.

References ossimFilename::dirCat(), ossimString::downcase(), ossimFilename::exists(), m_exists, m_fullValidPath, m_pathToFrameFileFromRoot, m_rootDirectory, and ossimString::upcase().

Referenced by ossimRpfFrameEntry().

{
   //---
   // We must check for case combinations:
   //---
   m_rootDirectory           = rootDirectory;
   m_pathToFrameFileFromRoot = pathToFrameFileFromRoot;
   m_fullValidPath = m_rootDirectory.dirCat(m_pathToFrameFileFromRoot);

   // Check as supplied:
   if(m_fullValidPath.exists())
   {
      m_exists = true;
   }
   else // Check root/downcased_path
   {
      m_pathToFrameFileFromRoot = m_pathToFrameFileFromRoot.downcase();
      m_fullValidPath = m_rootDirectory.dirCat(m_pathToFrameFileFromRoot);

      if(m_fullValidPath.exists())
      {
         m_exists = true;
      }
      else // Check root/upcased_path
      {
         m_pathToFrameFileFromRoot = m_pathToFrameFileFromRoot.upcase();
         m_fullValidPath =
            m_rootDirectory.dirCat(m_pathToFrameFileFromRoot);
         if(m_fullValidPath.exists())
         {
            m_exists = true;
         }
         else
         {
            m_pathToFrameFileFromRoot = pathToFrameFileFromRoot;
            m_fullValidPath =
               m_rootDirectory.dirCat(m_pathToFrameFileFromRoot);
            m_exists = false;
         }
      }
   }
}

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  out, const ossimRpfFrameEntry &  data  )

friend

Definition at line 17 of file ossimRpfFrameEntry.cpp.

{
   return data.print(out);
}

Member Data Documentation

m_exists

bool ossimRpfFrameEntry::m_exists

private

Definition at line 55 of file ossimRpfFrameEntry.h.

Referenced by exists(), operator=(), print(), and setEntry().

m_fullValidPath

ossimFilename ossimRpfFrameEntry::m_fullValidPath

private

Definition at line 58 of file ossimRpfFrameEntry.h.

Referenced by getFullPath(), operator=(), print(), and setEntry().

m_pathToFrameFileFromRoot

ossimFilename ossimRpfFrameEntry::m_pathToFrameFileFromRoot

private

Definition at line 57 of file ossimRpfFrameEntry.h.

Referenced by getPathToFrameFileFromRoot(), operator=(), print(), and setEntry().

m_rootDirectory

ossimFilename ossimRpfFrameEntry::m_rootDirectory

private

Definition at line 56 of file ossimRpfFrameEntry.h.

Referenced by getRootDirectory(), operator=(), print(), and setEntry().

---

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

• ossimRpfFrameEntry.h
• ossimRpfFrameEntry.cpp