ossimInfoBase Class Reference

Info Base. More...

#include <ossimInfoBase.h>

Inheritance diagram for ossimInfoBase:

Public Member Functions
	ossimInfoBase ()
	default constructor More...
virtual bool	open (const ossimFilename &file)
	open method. More...
virtual bool	open (std::shared_ptr< ossim::istream > &str, const std::string &connectionString)
	open method. More...
virtual std::ostream &	print (std::ostream &out) const =0
	Print method. More...
void	setProcessOverviewFlag (bool flag)
	Sets the overview flag. More...
bool	getProcessOverviewFlag () const
	Method to get the overview flag. More...
virtual bool	getKeywordlist (ossimKeywordlist &kwl) const
	Method to dump info to a keyword list. More...
virtual bool	getKeywordlist (ossimKeywordlist &kwl, ossim_uint32 entryIndex) const
	Method to dump info to a keyword list. More...
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const

Protected Member Functions
virtual	~ossimInfoBase ()
	virtual destructor More...
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
bool	theOverviewFlag

Detailed Description

Info Base.

This is the base class for all info objects. The purpose of an Info object is to dump whatever info is available for a given file name to user.

Definition at line 32 of file ossimInfoBase.h.

Constructor & Destructor Documentation

ossimInfoBase()

ossimInfoBase::ossimInfoBase

(

)

default constructor

Definition at line 19 of file ossimInfoBase.cpp.

   : theOverviewFlag(true)
{}

~ossimInfoBase()

ossimInfoBase::~ossimInfoBase ( )

protectedvirtual

virtual destructor

Definition at line 23 of file ossimInfoBase.cpp.

{}

Member Function Documentation

getKeywordlist() [1/2]

bool ossimInfoBase::getKeywordlist ( ossimKeywordlist &  kwl ) const

virtual

Method to dump info to a keyword list.

Parameters

kwl	The keyword list to initialize.

Returns

true on success, false on error.

Reimplemented in ossimOgrInfo, and ossimHdf5Info.

Definition at line 51 of file ossimInfoBase.cpp.

References ossimKeywordlist::parseStream(), and print().

Referenced by ossimKakaduJpipHandler::getImageGeometry(), and getKeywordlist().

{  
   // Do a print to a memory stream.
   std::ostringstream out;
   print(out);

   std::istringstream in(out.str());
   // Give the result to the keyword list.
   return kwl.parseStream(in);
}

getKeywordlist() [2/2]

bool ossimInfoBase::getKeywordlist ( ossimKeywordlist &  kwl, ossim_uint32  entryIndex  ) const

virtual

Method to dump info to a keyword list.

Parameters

kwl	The keyword list to initialize.
entryIndex	Entry to print. Not supported by all info objects yet.

Returns

true on success, false on error.

Reimplemented in ossimNitfInfo.

Definition at line 62 of file ossimInfoBase.cpp.

References getKeywordlist().

{
   // If this gets hit the specific info object does not support entry indexes.
   return getKeywordlist( kwl );
}

getProcessOverviewFlag()

bool ossimInfoBase::getProcessOverviewFlag

(

)

const

Method to get the overview flag.

Returns

The overview flag.

Definition at line 46 of file ossimInfoBase.cpp.

References theOverviewFlag.

Referenced by ossimNitfInfo::print().

{
   return theOverviewFlag;
}

open() [1/2]

bool ossimInfoBase::open ( const ossimFilename &  file )

virtual

open method.

Parameters

file	File name to open.

Returns

true on success false on error.

Reimplemented in ossimTiffInfo, ossimOgrInfo, ossimHdf5Info, ossimGeoPdfInfo, ossimKakaduJpipInfo, ossimXmpInfo, ossimH5Info, ossimCcfInfo, ossimJp2Info, ossimJ2kInfo, ossimDemInfo, ossimRpfInfo, ossimHdfInfo, ossimGpkgInfo, ossimLasInfo, ossimNitfInfo, and ossimEnviInfo.

Definition at line 26 of file ossimInfoBase.cpp.

References ossimString::c_str(), and ossim::StreamFactoryRegistry::instance().

Referenced by ossimH5InfoFactory::create(), and ossimDoqq::ossimDoqq().

{
   std::string connectionString = file.c_str();
   std::shared_ptr<ossim::istream> str = ossim::StreamFactoryRegistry::instance()->
      createIstream( file.c_str(), std::ios_base::in|std::ios_base::binary);
   if(!str) return false;
   return open(str, connectionString);
}

open() [2/2]

bool ossimInfoBase::open ( std::shared_ptr< ossim::istream > &  str, const std::string &  connectionString  )

virtual

open method.

Parameters

str	File name to open.

Returns

true on success false on error.

Reimplemented in ossimDoqq, ossimTiffInfo, ossimDtedInfo, ossimGeoPdfInfo, ossimCcfInfo, ossimDemInfo, and ossimNitfInfo.

Definition at line 35 of file ossimInfoBase.cpp.

{
   return false;
}

print()

virtual std::ostream& ossimInfoBase::print ( std::ostream &  out ) const

pure virtual

Print method.

Parameters

out	Stream to print to.

Returns

std::ostream&

Implemented in ossimDoqq, ossimTiffInfo, ossimOgrInfo, ossimDtedInfo, ossimGeoPdfInfo, ossimCcfInfo, ossimKakaduJpipInfo, ossimHdf5Info, ossimXmpInfo, ossimH5Info, ossimDemInfo, ossimJp2Info, ossimJ2kInfo, ossimNitfInfo, ossimRpfInfo, ossimHdfInfo, ossimGpkgInfo, ossimLasInfo, and ossimEnviInfo.

Referenced by getKeywordlist().

setProcessOverviewFlag()

void ossimInfoBase::setProcessOverviewFlag

(

bool

flag

)

Sets the overview flag.

Parameters

flag	If true overview info is processed also.

Definition at line 41 of file ossimInfoBase.cpp.

References theOverviewFlag.

Referenced by ossimKakaduJpipInfo::print().

{
   theOverviewFlag = flag;
}

Member Data Documentation

theOverviewFlag

bool ossimInfoBase::theOverviewFlag

protected

Definition at line 101 of file ossimInfoBase.h.

Referenced by getProcessOverviewFlag(), and setProcessOverviewFlag().

---

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

• ossimInfoBase.h
• ossimInfoBase.cpp