ossimProperty Class Reference

#include <ossimProperty.h>

Inheritance diagram for ossimProperty:

Public Types
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
	ossimProperty (const ossimString &name=ossimString(""))
	ossimProperty (const ossimProperty &rhs)
const ossimProperty &	operator= (const ossimProperty &rhs)
virtual const ossimProperty &	assign (const ossimProperty &rhs)
const ossimString &	getName () const
void	setName (const ossimString &name)
virtual bool	setValue (const ossimString &value)=0
virtual void	valueToString (ossimString &valueResult) const =0
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 ossimObject *	dup () const
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 Member Functions
virtual	~ossimProperty ()
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
ossimString	theName
ossimString	theDescription
bool	theReadOnlyFlag
ossimPropertyChangeType	theChangeType
bool	theModifiedFlag

Detailed Description

Definition at line 16 of file ossimProperty.h.

Member Enumeration Documentation

ossimPropertyChangeType

enum ossimProperty::ossimPropertyChangeType

This are bitwise and can be ored together The change type is very important and it determines how things are refreshed.

Enumerator
ossimPropertyChangeType_NOTSPECIFIED
ossimPropertyChangeType_CACHE_REFRESH
ossimPropertyChangeType_FULL_REFRESH
ossimPropertyChangeType_AFFECTS_OTHERS
ossimPropertyChangeType_ALL

Definition at line 24 of file ossimProperty.h.

   {
      ossimPropertyChangeType_NOTSPECIFIED   = 0,
      ossimPropertyChangeType_CACHE_REFRESH  = 1,
      ossimPropertyChangeType_FULL_REFRESH   = 2,
      ossimPropertyChangeType_AFFECTS_OTHERS = 4, // used to identify if this property modification affects the values of other properties once set
      ossimPropertyChangeType_ALL = (ossimPropertyChangeType_CACHE_REFRESH|ossimPropertyChangeType_FULL_REFRESH|ossimPropertyChangeType_AFFECTS_OTHERS)
   };

Constructor & Destructor Documentation

ossimProperty() [1/2]

ossimProperty::ossimProperty

(

const ossimString &

name = ossimString("")

)

Definition at line 22 of file ossimProperty.cpp.

   :theName(name),
    theReadOnlyFlag(false),
    theChangeType(ossimPropertyChangeType_NOTSPECIFIED),
    theModifiedFlag(false)
{
}

ossimProperty() [2/2]

ossimProperty::ossimProperty

(

const ossimProperty &

rhs

)

Definition at line 30 of file ossimProperty.cpp.

   :theName(rhs.theName),
    theReadOnlyFlag(rhs.theReadOnlyFlag),
    theChangeType(rhs.theChangeType),
    theModifiedFlag(rhs.theModifiedFlag)
{
}

~ossimProperty()

ossimProperty::~ossimProperty ( )

protectedvirtual

Definition at line 38 of file ossimProperty.cpp.

{
}

Member Function Documentation

accept()

void ossimProperty::accept ( ossimVisitor &  visitor )

virtual

Reimplemented from ossimObject.

Reimplemented in ossimContainerProperty.

Definition at line 184 of file ossimProperty.cpp.

References ossimObject::accept().

Referenced by ossimContainerProperty::accept().

{
   ossimObject::accept(visitor);
}

affectsOthers()

bool ossimProperty::affectsOthers

(

)

const

Definition at line 134 of file ossimProperty.cpp.

References isChangeTypeSet(), and ossimPropertyChangeType_AFFECTS_OTHERS.

{
   return isChangeTypeSet(ossimPropertyChangeType_AFFECTS_OTHERS);
}

asContainer() [1/2]

const ossimContainerProperty * ossimProperty::asContainer ( ) const

virtual

Reimplemented in ossimContainerProperty.

Definition at line 72 of file ossimProperty.cpp.

Referenced by saveState().

{
   return 0;
}

asContainer() [2/2]

ossimContainerProperty * ossimProperty::asContainer ( )

virtual

Reimplemented in ossimContainerProperty.

Definition at line 77 of file ossimProperty.cpp.

{
   return 0;
}

assign()

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

virtual

Reimplemented in ossimFilenameProperty, ossimNumericProperty, ossimStringProperty, ossimDateProperty, ossimMatrixProperty, ossimTextProperty, ossimDoubleGridProperty, ossimContainerProperty, ossimColorProperty, ossimFontProperty, ossimStringListProperty, and ossimBooleanProperty.

Definition at line 52 of file ossimProperty.cpp.

References theChangeType, theModifiedFlag, theName, and theReadOnlyFlag.

Referenced by ossimBooleanProperty::assign(), ossimColorProperty::assign(), ossimStringListProperty::assign(), ossimFontProperty::assign(), ossimContainerProperty::assign(), ossimDoubleGridProperty::assign(), ossimMatrixProperty::assign(), ossimDateProperty::assign(), ossimStringProperty::assign(), ossimNumericProperty::assign(), ossimFilenameProperty::assign(), and operator=().

{
   theName         = rhs.theName;
   theReadOnlyFlag = rhs.theReadOnlyFlag;
   theChangeType   = rhs.theChangeType;
   theModifiedFlag = rhs.theModifiedFlag;
   
   return *this;
}

clearChangeType()

void ossimProperty::clearChangeType

(

)

Definition at line 87 of file ossimProperty.cpp.

References ossimPropertyChangeType_NOTSPECIFIED, and theChangeType.

Referenced by ossimEdgeFilter::getProperty(), ossimImageRenderer::getProperty(), ossimBandSelector::getProperty(), ossimEquationCombiner::getProperty(), and ossimImageSource::getProperty().

{
   theChangeType = ossimPropertyChangeType_NOTSPECIFIED;
}

clearModifiedFlag()

void ossimProperty::clearModifiedFlag

(

)

Definition at line 169 of file ossimProperty.cpp.

References theModifiedFlag.

{
   theModifiedFlag = false;
}

getChangeType()

ossimProperty::ossimPropertyChangeType ossimProperty::getChangeType

(

)

const

Definition at line 114 of file ossimProperty.cpp.

References theChangeType.

{
   return theChangeType;
}

getDescription()

ossimString ossimProperty::getDescription ( ) const

virtual

Reimplemented from ossimObject.

Definition at line 179 of file ossimProperty.cpp.

References theDescription.

{
   return theDescription;
}

getModifiedFlag()

bool ossimProperty::getModifiedFlag

(

)

const

Definition at line 159 of file ossimProperty.cpp.

References theModifiedFlag.

{
   return theModifiedFlag;
}

getName()

const ossimString & ossimProperty::getName

(

)

const

Definition at line 42 of file ossimProperty.cpp.

References theName.

Referenced by ossimContainerProperty::getProperty(), saveState(), ossimImageSharpenFilter::setProperty(), ossim3x3ConvolutionFilter::setProperty(), ossimEdgeFilter::setProperty(), ossimImageGaussianFilter::setProperty(), ossimFftFilter::setProperty(), ossimPngCodec::setProperty(), ossimJpegCodec::setProperty(), ossimCastTileSourceFilter::setProperty(), ossimConvolutionFilter1D::setProperty(), ossimSlopeFilter::setProperty(), ossimJpegWriter::setProperty(), ossimGdalWriter::setProperty(), ossimKmlSuperOverlayWriter::setProperty(), ossimPngWriter::setProperty(), ossimNBandToIndexFilter::setProperty(), ossimRangeDomeTileSource::setProperty(), ossimTiffWriter::setProperty(), ossimPngReader::setProperty(), ossimBandSelector::setProperty(), ossimMaskFilter::setProperty(), ossimHdf5ImageHandler::setProperty(), ossimMapCompositionSource::setProperty(), ossimEquationCombiner::setProperty(), ossimH5ImageHandler::setProperty(), ossimPointCloudImageHandler::setProperty(), ossimGdalTileSource::setProperty(), ossimTiffTileSource::setProperty(), ossimLasReader::setProperty(), ossimImageFileWriter::setProperty(), ossimConnectableObject::setProperty(), ossimImageHandler::setProperty(), ossimContainerProperty::toXml(), and toXml().

{
   return theName;
}

getReadOnlyFlag()

bool ossimProperty::getReadOnlyFlag

(

)

const

Definition at line 144 of file ossimProperty.cpp.

References theReadOnlyFlag.

Referenced by isReadOnly().

{
   return theReadOnlyFlag;
}

isCacheRefresh()

bool ossimProperty::isCacheRefresh

(

)

const

Definition at line 124 of file ossimProperty.cpp.

References isChangeTypeSet(), and ossimPropertyChangeType_CACHE_REFRESH.

{
   return isChangeTypeSet(ossimPropertyChangeType_CACHE_REFRESH);
}

isChangeTypeSet()

bool ossimProperty::isChangeTypeSet

(

int

type

)

const

Definition at line 82 of file ossimProperty.cpp.

References theChangeType.

Referenced by affectsOthers(), isCacheRefresh(), and isFullRefresh().

{
   return ((type&theChangeType)!=0);
}

isChangeTypeSpecified()

bool ossimProperty::isChangeTypeSpecified

(

)

const

Definition at line 129 of file ossimProperty.cpp.

References ossimPropertyChangeType_NOTSPECIFIED, and theChangeType.

{
   return (theChangeType != ossimPropertyChangeType_NOTSPECIFIED);
}

isFullRefresh()

bool ossimProperty::isFullRefresh

(

)

const

Definition at line 119 of file ossimProperty.cpp.

References isChangeTypeSet(), and ossimPropertyChangeType_FULL_REFRESH.

{
   return isChangeTypeSet(ossimPropertyChangeType_FULL_REFRESH);
}

isModified()

bool ossimProperty::isModified

(

)

const

Definition at line 164 of file ossimProperty.cpp.

References theModifiedFlag.

{
   return (theModifiedFlag == true);
}

isReadOnly()

bool ossimProperty::isReadOnly

(

)

const

Definition at line 149 of file ossimProperty.cpp.

References getReadOnlyFlag().

{
   return (getReadOnlyFlag());
}

operator=()

const ossimProperty & ossimProperty::operator=

(

const ossimProperty &

rhs

)

Definition at line 15 of file ossimProperty.cpp.

References assign().

{
   this->assign(rhs);
   
   return *this;
}

saveState()

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

virtual

Definition at line 199 of file ossimProperty.cpp.

References ossimKeywordlist::add(), asContainer(), getName(), ossimContainerProperty::getNumberOfProperties(), saveState(), ossimContainerProperty::theChildPropertyList, ossimRefPtr< T >::valid(), and valueToString().

Referenced by saveState().

{
   const ossimContainerProperty* container = asContainer();
   if(container)
   {
      ossim_uint32 nproperties     = container->getNumberOfProperties();
      ossim_uint32 propertiesIndex = 0;
      for(propertiesIndex = 0; propertiesIndex < nproperties; ++propertiesIndex)
      {
         ossimString newPrefix = prefix + container->getName() + ".";
         ossimRefPtr<ossimProperty> prop = container->theChildPropertyList[propertiesIndex];
         if(prop.valid())
         {
            prop->saveState(kwl, newPrefix);
         }
      }
   }
   else 
   {
      kwl.add(prefix + getName(), valueToString(), true);
   }
}

setCacheRefreshBit()

void ossimProperty::setCacheRefreshBit

(

)

Definition at line 109 of file ossimProperty.cpp.

References ossimPropertyChangeType_CACHE_REFRESH, and setChangeType().

Referenced by ossimDespeckleFilter::getProperty(), ossimBrightnessMatch::getProperty(), ossimEdgeFilter::getProperty(), ossimFftFilter::getProperty(), ossimImageToPlaneNormalFilter::getProperty(), ossimKakaduJpipHandler::getProperty(), ossimCastTileSourceFilter::getProperty(), ossimGdalOgrVectorAnnotation::getProperty(), ossimBrightnessContrastSource::getProperty(), ossimHistogramMatchFilter::getProperty(), ossimImageRenderer::getProperty(), ossimWatermarkFilter::getProperty(), ossimBandSelector::getProperty(), ossimMapCompositionSource::getProperty(), ossimEquationCombiner::getProperty(), ossimPixelFlipper::getProperty(), ossimBumpShadeTileSource::getProperty(), and ossimImageHandler::getProperty().

{
   setChangeType(ossimPropertyChangeType_CACHE_REFRESH);
}

setChangeType()

void ossimProperty::setChangeType	(	int	type,
		bool	on = true
	)

Definition at line 92 of file ossimProperty.cpp.

References theChangeType.

Referenced by ossimImageFileWriter::getProperty(), setCacheRefreshBit(), and setFullRefreshBit().

{
   if(on)
   {
      theChangeType = static_cast<ossimPropertyChangeType>(theChangeType | type);
   }
   else 
   {
      theChangeType = static_cast<ossimPropertyChangeType>((~type)&theChangeType);
   }
}

setDescription()

void ossimProperty::setDescription

(

const ossimString &

description

)

Definition at line 174 of file ossimProperty.cpp.

References theDescription.

{
   theDescription = description;
}

setFullRefreshBit()

void ossimProperty::setFullRefreshBit

(

)

Definition at line 104 of file ossimProperty.cpp.

References ossimPropertyChangeType_FULL_REFRESH, and setChangeType().

Referenced by ossimTrimFilter::getProperty(), ossimKakaduJpipHandler::getProperty(), ossimGdalOgrVectorAnnotation::getProperty(), ossimImageSource::getProperty(), and ossimImageHandler::getProperty().

{
   setChangeType(ossimPropertyChangeType_FULL_REFRESH);
}

setModifiedFlag()

void ossimProperty::setModifiedFlag

(

bool

flag

)

Definition at line 154 of file ossimProperty.cpp.

References theModifiedFlag.

{
   theModifiedFlag = flag;
}

setName()

void ossimProperty::setName

(

const ossimString &

name

)

Definition at line 47 of file ossimProperty.cpp.

References theName.

Referenced by ossimDtedInfo::getProperty().

{
   theName = name;
}

setReadOnlyFlag()

void ossimProperty::setReadOnlyFlag ( bool  flag )

virtual

Reimplemented in ossimContainerProperty.

Definition at line 139 of file ossimProperty.cpp.

References theReadOnlyFlag.

Referenced by ossimContainerProperty::addStringProperty(), ossimEdgeFilter::getProperty(), ossimImageRenderer::getProperty(), ossimBandSelector::getProperty(), ossimNitfTileSource::getProperty(), ossimEquationCombiner::getProperty(), ossimImageFileWriter::getProperty(), ossimConnectableObject::getProperty(), ossimImageHandler::getProperty(), and ossimContainerProperty::setReadOnlyFlag().

{
   theReadOnlyFlag = flag;
}

setValue()

virtual bool ossimProperty::setValue ( const ossimString &  value )

pure virtual

Implemented in ossimStringProperty, ossimContainerProperty, ossimNumericProperty, ossimFilenameProperty, ossimDoubleGridProperty, ossimMatrixProperty, ossimDateProperty, ossimTextProperty, ossimBinaryDataProperty, ossimColorProperty, ossimFontProperty, ossimStringListProperty, and ossimBooleanProperty.

toXml()

ossimRefPtr< ossimXmlNode > ossimProperty::toXml ( ) const

virtual

Reimplemented in ossimContainerProperty.

Definition at line 189 of file ossimProperty.cpp.

References getName(), ossimXmlNode::setTag(), ossimXmlNode::setText(), and valueToString().

{
   ossimRefPtr<ossimXmlNode> result = new ossimXmlNode();
   
   result->setTag(getName());
   result->setText(valueToString());
   
   return result;
}

valueToString() [1/2]

virtual void ossimProperty::valueToString ( ossimString &  valueResult ) const

pure virtual

Implemented in ossimStringProperty, ossimContainerProperty, ossimNumericProperty, ossimFilenameProperty, ossimDoubleGridProperty, ossimMatrixProperty, ossimDateProperty, ossimBinaryDataProperty, ossimTextProperty, ossimBooleanProperty, ossimColorProperty, ossimFontProperty, and ossimStringListProperty.

Referenced by ossimNitfWriter::addDataExtensionSegment(), ossimColorProperty::assign(), ossimDoubleGridProperty::assign(), ossimTextProperty::assign(), ossimDateProperty::assign(), ossimStringProperty::assign(), ossimNumericProperty::assign(), ossimFilenameProperty::assign(), ossimHistogramMatchFilter::autoLoadInputHistogram(), ossimPropertyInterface::getPropertyValueAsString(), ossimInfo::isImageEntryOverview(), ossimFftFilter::setProperty(), ossimKakaduJpipHandler::setProperty(), ossimNitfDataExtensionSegmentV2_1::setProperty(), ossimCastTileSourceFilter::setProperty(), ossimSlopeFilter::setProperty(), ossimGdalWriter::setProperty(), ossimNitfImageHeaderV2_X::setProperty(), ossimHistogramMatchFilter::setProperty(), ossimNBandToIndexFilter::setProperty(), ossimNitfFileHeaderV2_X::setProperty(), ossimTiffWriter::setProperty(), ossimPdfWriter::setProperty(), ossimImageRenderer::setProperty(), ossimNitfImageHeaderV2_1::setProperty(), ossimBandSelector::setProperty(), ossimMetadataFileWriter::setProperty(), ossimMapCompositionSource::setProperty(), ossimEquationCombiner::setProperty(), ossimTiffTileSource::setProperty(), ossimNitfFileHeaderV2_1::setProperty(), ossimNitfFileHeaderV2_0::setProperty(), and ossimImageHandler::setProperty().

valueToString() [2/2]

ossimString ossimProperty::valueToString ( ) const

virtual

Definition at line 62 of file ossimProperty.cpp.

Referenced by saveState(), and toXml().

{
   ossimString result;

   valueToString(result);
   
   return result;
   
}

Member Data Documentation

theChangeType

ossimPropertyChangeType ossimProperty::theChangeType

protected

Definition at line 82 of file ossimProperty.h.

Referenced by assign(), clearChangeType(), getChangeType(), isChangeTypeSet(), isChangeTypeSpecified(), and setChangeType().

theDescription

ossimString ossimProperty::theDescription

protected

Definition at line 80 of file ossimProperty.h.

Referenced by getDescription(), and setDescription().

theModifiedFlag

bool ossimProperty::theModifiedFlag

protected

Definition at line 83 of file ossimProperty.h.

Referenced by assign(), clearModifiedFlag(), getModifiedFlag(), isModified(), and setModifiedFlag().

theName

ossimString ossimProperty::theName

protected

Definition at line 79 of file ossimProperty.h.

Referenced by assign(), getName(), and setName().

theReadOnlyFlag

bool ossimProperty::theReadOnlyFlag

protected

Definition at line 81 of file ossimProperty.h.

Referenced by assign(), getReadOnlyFlag(), and setReadOnlyFlag().

---

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

• ossimProperty.h
• ossimProperty.cpp