ossimNumericProperty Class Reference

#include <ossimNumericProperty.h>

Inheritance diagram for ossimNumericProperty:

Public Types
enum	ossimNumericPropertyType { ossimNumericPropertyType_INT = 0, ossimNumericPropertyType_UINT, ossimNumericPropertyType_FLOAT32, ossimNumericPropertyType_FLOAT64 }
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
	ossimNumericProperty (const ossimString &name=ossimString(""), const ossimString &value=ossimString("0"))
	ossimNumericProperty (const ossimString &name, const ossimString &value, double minValue, double maxValue)
	ossimNumericProperty (const ossimNumericProperty &rhs)
virtual ossimObject *	dup () const
virtual const ossimProperty &	assign (const ossimProperty &rhs)
virtual bool	hasConstraints () const
double	getMinValue () const
double	getMaxValue () const
virtual void	clearConstraints ()
virtual void	setConstraints (double minValue, double maxValue)
virtual bool	setValue (const ossimString &value)
virtual void	valueToString (ossimString &valueResult) const
virtual ossimNumericPropertyType	getNumericType () const
virtual void	setNumericType (ossimNumericPropertyType type)
virtual ossim_float64	asFloat64 () const
virtual ossim_float32	asFloat32 () const
virtual ossim_uint32	asUInt32 () const
virtual ossim_uint16	asUInt16 () const
virtual ossim_uint8	asUInt8 () const
virtual ossim_sint32	asInt32 () const
virtual ossim_sint16	asInt16 () const
virtual ossim_sint8	asInt8 () 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
ossimString	theValue
ossimNumericPropertyType	theType
std::vector< double >	theRangeConstraint
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 13 of file ossimNumericProperty.h.

Member Enumeration Documentation

ossimNumericPropertyType

enum ossimNumericProperty::ossimNumericPropertyType

Enumerator
ossimNumericPropertyType_INT
ossimNumericPropertyType_UINT
ossimNumericPropertyType_FLOAT32
ossimNumericPropertyType_FLOAT64

Definition at line 16 of file ossimNumericProperty.h.

   {
      ossimNumericPropertyType_INT   = 0,
      ossimNumericPropertyType_UINT,
      ossimNumericPropertyType_FLOAT32,
      ossimNumericPropertyType_FLOAT64
   };

Constructor & Destructor Documentation

ossimNumericProperty() [1/3]

ossimNumericProperty::ossimNumericProperty	(	const ossimString &	name = ossimString(""),
		const ossimString &	value = ossimString("0")
	)

Definition at line 15 of file ossimNumericProperty.cpp.

Referenced by dup().

   :ossimProperty(name),
    theValue(value),
    theType(ossimNumericPropertyType_FLOAT64)
{
}

ossimNumericProperty() [2/3]

ossimNumericProperty::ossimNumericProperty	(	const ossimString &	name,
		const ossimString &	value,
		double	minValue,
		double	maxValue
	)

Definition at line 23 of file ossimNumericProperty.cpp.

References setConstraints().

   :ossimProperty(name),
    theValue(value),
    theType(ossimNumericPropertyType_FLOAT64)
{
   setConstraints(minValue,
                  maxValue);
}

ossimNumericProperty() [3/3]

ossimNumericProperty::ossimNumericProperty

(

const ossimNumericProperty &

rhs

)

Definition at line 35 of file ossimNumericProperty.cpp.

   :ossimProperty(rhs),
    theValue(rhs.theValue),
    theType(rhs.theType),
    theRangeConstraint(rhs.theRangeConstraint)
{
}

Member Function Documentation

asFloat32()

ossim_float32 ossimNumericProperty::asFloat32 ( ) const

virtual

Definition at line 176 of file ossimNumericProperty.cpp.

References theValue, and ossimString::toDouble().

Referenced by valueToString().

{
   return (ossim_float32)theValue.toDouble();
}

asFloat64()

ossim_float64 ossimNumericProperty::asFloat64 ( ) const

virtual

Definition at line 171 of file ossimNumericProperty.cpp.

References theValue, and ossimString::toDouble().

Referenced by valueToString().

{
   return (ossim_float64)theValue.toDouble();
}

asInt16()

ossim_sint16 ossimNumericProperty::asInt16 ( ) const

virtual

Definition at line 201 of file ossimNumericProperty.cpp.

References theValue, and ossimString::toInt32().

{
   return (ossim_int16)theValue.toInt32();
}

asInt32()

ossim_sint32 ossimNumericProperty::asInt32 ( ) const

virtual

Definition at line 196 of file ossimNumericProperty.cpp.

References theValue, and ossimString::toInt32().

Referenced by ossimConvolutionFilter1D::setProperty(), and valueToString().

{
   return (ossim_int32)theValue.toInt32();
}

asInt8()

ossim_sint8 ossimNumericProperty::asInt8 ( ) const

virtual

Definition at line 206 of file ossimNumericProperty.cpp.

References theValue, and ossimString::toInt32().

{
   return (ossim_int8)theValue.toInt32();
}

assign()

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

virtual

Reimplemented from ossimProperty.

Definition at line 48 of file ossimNumericProperty.cpp.

References ossimProperty::assign(), setValue(), theRangeConstraint, theType, theValue, and ossimProperty::valueToString().

{
   ossimProperty::assign(rhs);

   const ossimNumericProperty* numericProperty = dynamic_cast<const ossimNumericProperty*>(&rhs);
   if(numericProperty)
   {
      theValue           = numericProperty->theValue;
      theType            = numericProperty->theType;
      theRangeConstraint = numericProperty->theRangeConstraint;
   }
   else
   {
      ossimString value;
      rhs.valueToString(value);
      setValue(value);
   }
   return *this;
}

asUInt16()

ossim_uint16 ossimNumericProperty::asUInt16 ( ) const

virtual

Definition at line 186 of file ossimNumericProperty.cpp.

References theValue, and ossimString::toUInt32().

{
   return (ossim_uint16)theValue.toUInt32();
}

asUInt32()

ossim_uint32 ossimNumericProperty::asUInt32 ( ) const

virtual

Definition at line 181 of file ossimNumericProperty.cpp.

References theValue, and ossimString::toUInt32().

Referenced by ossimConvolutionFilter1D::setProperty(), and valueToString().

{
   return theValue.toUInt32();
}

asUInt8()

ossim_uint8 ossimNumericProperty::asUInt8 ( ) const

virtual

Definition at line 191 of file ossimNumericProperty.cpp.

References theValue, and ossimString::toUInt32().

{
   return (ossim_uint8)theValue.toUInt32();
}

clearConstraints()

void ossimNumericProperty::clearConstraints ( )

virtual

Definition at line 93 of file ossimNumericProperty.cpp.

References theRangeConstraint.

{
   theRangeConstraint.clear();
}

dup()

ossimObject * ossimNumericProperty::dup ( ) const

virtual

Reimplemented from ossimObject.

Definition at line 43 of file ossimNumericProperty.cpp.

References ossimNumericProperty().

{
   return new ossimNumericProperty(*this);
}

getMaxValue()

double ossimNumericProperty::getMaxValue

(

)

const

Definition at line 83 of file ossimNumericProperty.cpp.

References hasConstraints(), and theRangeConstraint.

{
   if(hasConstraints())
   {
      return theRangeConstraint[1];
   }

   return 0.0;
}

getMinValue()

double ossimNumericProperty::getMinValue

(

)

const

Definition at line 73 of file ossimNumericProperty.cpp.

References hasConstraints(), and theRangeConstraint.

{
   if(hasConstraints())
   {
      return theRangeConstraint[0];
   }

   return 0.0;
}

getNumericType()

ossimNumericProperty::ossimNumericPropertyType ossimNumericProperty::getNumericType ( ) const

virtual

Definition at line 161 of file ossimNumericProperty.cpp.

References theType.

{
   return theType;
}

hasConstraints()

bool ossimNumericProperty::hasConstraints ( ) const

virtual

Definition at line 68 of file ossimNumericProperty.cpp.

References theRangeConstraint.

Referenced by getMaxValue(), getMinValue(), and setValue().

{
   return (theRangeConstraint.size() == 2);
}

setConstraints()

void ossimNumericProperty::setConstraints ( double  minValue, double  maxValue  )

virtual

Definition at line 98 of file ossimNumericProperty.cpp.

References theRangeConstraint.

Referenced by ossimNumericProperty().

{
   theRangeConstraint.resize(2);
   theRangeConstraint[0] = minValue;
   theRangeConstraint[1] = maxValue;

   if(minValue > maxValue)
   {
      std::swap(theRangeConstraint[0],
                theRangeConstraint[1]);
   }
}

setNumericType()

void ossimNumericProperty::setNumericType ( ossimNumericPropertyType  type )

virtual

Definition at line 166 of file ossimNumericProperty.cpp.

References theType.

Referenced by ossimBrightnessMatch::getProperty(), ossimGdalOgrVectorAnnotation::getProperty(), ossimBrightnessContrastSource::getProperty(), ossimJpegWriter::getProperty(), ossimNitfFileHeaderV2_X::getProperty(), and ossimTiffWriter::getProperty().

{
   theType = type;
}

setValue()

bool ossimNumericProperty::setValue ( const ossimString &  value )

virtual

Implements ossimProperty.

Definition at line 112 of file ossimNumericProperty.cpp.

References hasConstraints(), theRangeConstraint, theValue, and ossimString::toDouble().

Referenced by assign().

{
   bool result = true;
   if(hasConstraints())
   {
      ossim_float64 tempV = (ossim_float64)value.toDouble();
      if((tempV >= theRangeConstraint[0])&&
         (tempV <= theRangeConstraint[1]))
      {
         theValue = value;
      }
   }
   else
   {
     theValue = value;
   }

   return result;
}

valueToString()

void ossimNumericProperty::valueToString ( ossimString &  valueResult ) const

virtual

Implements ossimProperty.

Definition at line 132 of file ossimNumericProperty.cpp.

References asFloat32(), asFloat64(), asInt32(), asUInt32(), ossimNumericPropertyType_FLOAT32, ossimNumericPropertyType_FLOAT64, ossimNumericPropertyType_INT, ossimNumericPropertyType_UINT, theType, and ossimString::toString().

{
   switch(theType)
   {
   case ossimNumericPropertyType_INT:
   {
      valueResult = ossimString::toString(asInt32());
      break;
   }
   case ossimNumericPropertyType_UINT:
   {
      valueResult = ossimString::toString(asUInt32());
      break;
   }
   case ossimNumericPropertyType_FLOAT32:
   {
      valueResult = ossimString::toString(asFloat32());
      
      break;
   }
   case ossimNumericPropertyType_FLOAT64:
   {
      valueResult = ossimString::toString(asFloat64());
      break;
   }
   };
}

Member Data Documentation

theRangeConstraint

std::vector<double> ossimNumericProperty::theRangeConstraint

protected

Definition at line 59 of file ossimNumericProperty.h.

Referenced by assign(), clearConstraints(), getMaxValue(), getMinValue(), hasConstraints(), setConstraints(), and setValue().

theType

ossimNumericPropertyType ossimNumericProperty::theType

protected

Definition at line 58 of file ossimNumericProperty.h.

Referenced by assign(), getNumericType(), setNumericType(), and valueToString().

theValue

ossimString ossimNumericProperty::theValue

protected

Definition at line 57 of file ossimNumericProperty.h.

Referenced by asFloat32(), asFloat64(), asInt16(), asInt32(), asInt8(), assign(), asUInt16(), asUInt32(), asUInt8(), and setValue().

---

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

• ossimNumericProperty.h
• ossimNumericProperty.cpp