#include <ossimFilenameProperty.h>

Inheritance diagram for ossimFilenameProperty:

Public Types
enum	ossimFilenamePropertyIoType { ossimFilenamePropertyIoType_NOT_SPECIFIED = 0, ossimFilenamePropertyIoType_INPUT = 1, ossimFilenamePropertyIoType_OUTPUT = 2 }

Public Types inherited from ossimProperty
enum	ossimPropertyChangeType { ossimPropertyChangeType_NOTSPECIFIED = 0, ossimPropertyChangeType_CACHE_REFRESH = 1, ossimPropertyChangeType_FULL_REFRESH = 2, ossimPropertyChangeType_AFFECTS_OTHERS = 4, ossimPropertyChangeType_ALL = (ossimPropertyChangeType_CACHE_REFRESH\|ossimPropertyChangeType_FULL_REFRESH\|ossimPropertyChangeType_AFFECTS_OTHERS) }

Public Member Functions
	ossimFilenameProperty (const ossimString &name=ossimString(""), const ossimFilename &value=ossimFilename(""), const std::vector< ossimString > &filterList=std::vector< ossimString >())

	ossimFilenameProperty (const ossimFilenameProperty &rhs)

virtual	~ossimFilenameProperty ()

ossimObject *	dup () const

virtual void	valueToString (ossimString &valueResult) const

virtual bool	setValue (const ossimString &value)

const ossimFilenameProperty &	operator= (ossimFilenameProperty &rhs)

virtual const ossimProperty &	assign (const ossimProperty &rhs)

void	clearFilterList ()

ossim_uint32	getNumberOfFilters () const

void	setFilter (ossim_uint32 idx, const ossimString &filterValue)

ossimString	getFilter (ossim_uint32 idx) const

ossimString	getFilterListAsString (const ossimString &separator=ossimString("\)) const

const std::vector< ossimString > &	getFilterList () const

void	addFilter (const ossimString &filter)

void	setIoType (ossimFilenamePropertyIoType ioType)

ossimFilenamePropertyIoType	getIoType () const

bool	isIoTypeInput () const

bool	isIoTypeOutput () const

Public Member Functions inherited from ossimProperty
	ossimProperty (const ossimString &name=ossimString(""))

	ossimProperty (const ossimProperty &rhs)

const ossimProperty &	operator= (const ossimProperty &rhs)

const ossimString &	getName () const

void	setName (const ossimString &name)

virtual ossimString	valueToString () const

virtual const ossimContainerProperty *	asContainer () const

virtual ossimContainerProperty *	asContainer ()

bool	isChangeTypeSet (int type) const

void	clearChangeType ()

void	setChangeType (int type, bool on=true)

void	setFullRefreshBit ()

void	setCacheRefreshBit ()

ossimPropertyChangeType	getChangeType () const

bool	isFullRefresh () const

bool	isCacheRefresh () const

bool	isChangeTypeSpecified () const

bool	affectsOthers () const

virtual void	setReadOnlyFlag (bool flag)

bool	getReadOnlyFlag () const

bool	isReadOnly () const

void	setModifiedFlag (bool flag)

bool	getModifiedFlag () const

bool	isModified () const

void	clearModifiedFlag ()

void	setDescription (const ossimString &description)

virtual ossimString	getDescription () const

virtual ossimRefPtr< ossimXmlNode >	toXml () const

virtual void	saveState (ossimKeywordlist &kwl, const ossimString &prefix="") const

virtual void	accept (ossimVisitor &visitor)

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)

virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...

virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const

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 Attributes
ossimFilename	theValue

std::vector< ossimString >	theFilterList

ossimFilenamePropertyIoType	theIoType

Protected Attributes inherited from ossimProperty
ossimString	theName

ossimString	theDescription

bool	theReadOnlyFlag

ossimPropertyChangeType	theChangeType

bool	theModifiedFlag

Additional Inherited Members
Protected Member Functions inherited from ossimProperty
virtual	~ossimProperty ()

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

Definition at line 16 of file ossimFilenameProperty.h.

Member Enumeration Documentation

◆ ossimFilenamePropertyIoType

enum ossimFilenameProperty::ossimFilenamePropertyIoType

Enumerator
ossimFilenamePropertyIoType_NOT_SPECIFIED
ossimFilenamePropertyIoType_INPUT
ossimFilenamePropertyIoType_OUTPUT

Definition at line 20 of file ossimFilenameProperty.h.

    {
       ossimFilenamePropertyIoType_NOT_SPECIFIED = 0,
       ossimFilenamePropertyIoType_INPUT         = 1,
       ossimFilenamePropertyIoType_OUTPUT        = 2
    };

Constructor & Destructor Documentation

◆ ossimFilenameProperty() [1/2]

ossimFilenameProperty::ossimFilenameProperty	(	const ossimString &	name = `ossimString("")`,
		const ossimFilename &	value = `ossimFilename("")`,
		const std::vector< ossimString > &	filterList = `std::vector<ossimString>()`
	)

Definition at line 13 of file ossimFilenameProperty.cpp.

Referenced by dup().

    :ossimProperty(name),
     theValue(value),
     theFilterList(filterList),
     theIoType(ossimFilenamePropertyIoType_NOT_SPECIFIED)
 {
 }

◆ ossimFilenameProperty() [2/2]

ossimFilenameProperty::ossimFilenameProperty ( const ossimFilenameProperty & rhs )

Definition at line 23 of file ossimFilenameProperty.cpp.

    :ossimProperty(rhs),
     theValue(rhs.theValue),
     theFilterList(rhs.theFilterList),
     theIoType(rhs.theIoType)
 {
 }

◆ ~ossimFilenameProperty()

ossimFilenameProperty::~ossimFilenameProperty ( )

virtual

Definition at line 31 of file ossimFilenameProperty.cpp.

32 {

33 }

Member Function Documentation

◆ addFilter()

void ossimFilenameProperty::addFilter ( const ossimString & filter )

Definition at line 128 of file ossimFilenameProperty.cpp.

References theFilterList.

Referenced by ossimTiffWriter::getProperty().

 {
    theFilterList.push_back(filter);
 }

◆ assign()

const ossimProperty & ossimFilenameProperty::assign ( const ossimProperty & rhs )

virtual

Reimplemented from ossimProperty.

Definition at line 59 of file ossimFilenameProperty.cpp.

References ossimProperty::assign(), theFilterList, theIoType, theValue, and ossimProperty::valueToString().

Referenced by operator=().

 {
    ossimProperty::assign(rhs);
    theValue = rhs.valueToString();
 
    const ossimFilenameProperty* rhsPtr = dynamic_cast<const ossimFilenameProperty*>(&rhs);
    if(rhsPtr)
    {
       theFilterList = rhsPtr->theFilterList;
       theIoType     = rhsPtr->theIoType;
    }
 
    return *this;
 }

◆ clearFilterList()

void ossimFilenameProperty::clearFilterList ( )

Definition at line 74 of file ossimFilenameProperty.cpp.

References theFilterList.

 {
    theFilterList.clear();
 }

◆ dup()

ossimObject * ossimFilenameProperty::dup ( ) const

virtual

Reimplemented from ossimObject.

Definition at line 35 of file ossimFilenameProperty.cpp.

References ossimFilenameProperty().

 {
    return new ossimFilenameProperty(*this);
 }

◆ getFilter()

ossimString ossimFilenameProperty::getFilter ( ossim_uint32 idx ) const

Definition at line 93 of file ossimFilenameProperty.cpp.

References getNumberOfFilters(), and theFilterList.

Referenced by getFilterListAsString().

 {
    if(idx < getNumberOfFilters())
    {
       return theFilterList[idx];
    }
 
    return ossimString("");
 }

◆ getFilterList()

const std::vector< ossimString > & ossimFilenameProperty::getFilterList ( ) const

Definition at line 123 of file ossimFilenameProperty.cpp.

References theFilterList.

 {
    return theFilterList;
 }

◆ getFilterListAsString()

ossimString ossimFilenameProperty::getFilterListAsString ( const ossimString & separator = ossimString("\n") ) const

Definition at line 104 of file ossimFilenameProperty.cpp.

References getFilter(), and getNumberOfFilters().

 {
    ossimString result;
    ossim_uint32 idx = 0;
 
    if(getNumberOfFilters() > 0)
    {
       for(idx = 0; idx < getNumberOfFilters()-1;++idx)
       {
          result += getFilter(idx);
          result += separator;
       }
       result += getFilter(getNumberOfFilters()-1);
    }
 
    return result;
 }

◆ getIoType()

ossimFilenameProperty::ossimFilenamePropertyIoType ossimFilenameProperty::getIoType ( ) const

Definition at line 139 of file ossimFilenameProperty.cpp.

References theIoType.

 {
    return theIoType;
 }

◆ getNumberOfFilters()

ossim_uint32 ossimFilenameProperty::getNumberOfFilters ( ) const

Definition at line 79 of file ossimFilenameProperty.cpp.

References theFilterList.

Referenced by getFilter(), getFilterListAsString(), and setFilter().

 {
    return (ossim_uint32)theFilterList.size();
 }

◆ isIoTypeInput()

bool ossimFilenameProperty::isIoTypeInput ( ) const

Definition at line 144 of file ossimFilenameProperty.cpp.

References ossimFilenamePropertyIoType_INPUT, and theIoType.

 {
    return (theIoType==ossimFilenamePropertyIoType_INPUT);
 }

◆ isIoTypeOutput()

bool ossimFilenameProperty::isIoTypeOutput ( ) const

Definition at line 149 of file ossimFilenameProperty.cpp.

References ossimFilenamePropertyIoType_OUTPUT, and theIoType.

 {
    return (theIoType==ossimFilenamePropertyIoType_OUTPUT);
 }

◆ operator=()

const ossimFilenameProperty & ossimFilenameProperty::operator= ( ossimFilenameProperty & rhs )

Definition at line 52 of file ossimFilenameProperty.cpp.

References assign().

 {
    assign(rhs);
 
    return *this;
 }

◆ setFilter()

void ossimFilenameProperty::setFilter	(	ossim_uint32	idx,
		const ossimString &	filterValue
	)

Definition at line 84 of file ossimFilenameProperty.cpp.

References getNumberOfFilters(), and theFilterList.

 {
    if(idx < getNumberOfFilters())
    {
       theFilterList[idx] = filterValue;
    }
 }

◆ setIoType()

void ossimFilenameProperty::setIoType ( ossimFilenamePropertyIoType ioType )

Definition at line 134 of file ossimFilenameProperty.cpp.

References theIoType.

Referenced by ossimHistogramMatchFilter::getProperty(), ossimWatermarkFilter::getProperty(), ossimMetadataFileWriter::getProperty(), ossimImageFileWriter::getProperty(), and ossimImageHandler::getProperty().

 {
    theIoType = ioType;
 }

◆ setValue()

bool ossimFilenameProperty::setValue ( const ossimString & value )

virtual

Implements ossimProperty.

Definition at line 45 of file ossimFilenameProperty.cpp.

References theValue.

 {
    theValue = value;
 
    return true;
 }

◆ valueToString()

void ossimFilenameProperty::valueToString ( ossimString & valueResult ) const

virtual

Implements ossimProperty.

Definition at line 40 of file ossimFilenameProperty.cpp.

References theValue.

 {
    valueResult = theValue;
 }

Member Data Documentation

◆ theFilterList

std::vector<ossimString> ossimFilenameProperty::theFilterList

protected

Definition at line 55 of file ossimFilenameProperty.h.

Referenced by addFilter(), assign(), clearFilterList(), getFilter(), getFilterList(), getNumberOfFilters(), and setFilter().

◆ theIoType

ossimFilenamePropertyIoType ossimFilenameProperty::theIoType

protected

Definition at line 56 of file ossimFilenameProperty.h.

Referenced by assign(), getIoType(), isIoTypeInput(), isIoTypeOutput(), and setIoType().

◆ theValue

ossimFilename ossimFilenameProperty::theValue

protected

Definition at line 54 of file ossimFilenameProperty.h.

Referenced by assign(), setValue(), and valueToString().

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

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ossimFilenamePropertyIoType

Constructor & Destructor Documentation

◆ ossimFilenameProperty() [1/2]

◆ ossimFilenameProperty() [2/2]

◆ ~ossimFilenameProperty()

Member Function Documentation

◆ addFilter()

◆ assign()

◆ clearFilterList()

◆ dup()

◆ getFilter()

◆ getFilterList()

◆ getFilterListAsString()

◆ getIoType()

◆ getNumberOfFilters()

◆ isIoTypeInput()

◆ isIoTypeOutput()

◆ operator=()

◆ setFilter()

◆ setIoType()

◆ setValue()

◆ valueToString()

Member Data Documentation

◆ theFilterList

◆ theIoType

◆ theValue