#include <ossimStringListProperty.h>

Inheritance diagram for ossimStringListProperty:

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

	ossimStringListProperty (const ossimStringListProperty &rhs)

ossimObject *	dup () const

virtual const ossimProperty &	assign (const ossimProperty &rhs)

virtual bool	setValue (const ossimString &value)

virtual void	valueToString (ossimString &valueResult) const

void	clearValueList ()

ossimString	getValueAt (int idx) const

bool	setValueAt (int idx, const ossimString &value)

bool	addValue (const ossimString &value)

ossim_uint32	getNumberOfValues () const

ossim_uint32	getNumberOfContraints () const

ossimString	getConstraintAt (ossim_uint32 idx) const

void	setConstraints (const std::vector< ossimString > &constraints)

bool	hasConstraints () const

void	setUniqueFlag (bool flag)

void	setOrderMattersFlag (bool flag)

void	setNumberOfValuesBounds (int minNumber, int maxNumber)

void	getNumberofValuesBounds (int &minNumber, int &maxNumber) 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 Member Functions
bool	findValueInConstraintList (const ossimString &value) const

bool	findValueInValueList (const ossimString &value) const

bool	canAddValue (const ossimString &value) const

Protected Member Functions inherited from ossimProperty
virtual	~ossimProperty ()

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
std::vector< ossimString >	theValueList

std::vector< ossimString >	theConstraintList

bool	theUniqueFlag

bool	theOrderMattersFlag

int	theMinNumberOfValues

int	theMaxNumberOfValues

Protected Attributes inherited from ossimProperty
ossimString	theName

ossimString	theDescription

bool	theReadOnlyFlag

ossimPropertyChangeType	theChangeType

bool	theModifiedFlag

Additional Inherited Members
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) }

Detailed Description

Definition at line 14 of file ossimStringListProperty.h.

Constructor & Destructor Documentation

◆ ossimStringListProperty() [1/2]

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

Definition at line 17 of file ossimStringListProperty.cpp.

Referenced by dup().

    :ossimProperty(name),
     theValueList(value),
     theUniqueFlag(false),
     theOrderMattersFlag(false)
 {
 }

◆ ossimStringListProperty() [2/2]

ossimStringListProperty::ossimStringListProperty ( const ossimStringListProperty & rhs )

Definition at line 26 of file ossimStringListProperty.cpp.

    :ossimProperty(rhs),
     theValueList(rhs.theValueList),
     theConstraintList(rhs.theConstraintList),
     theUniqueFlag(rhs.theUniqueFlag),
     theOrderMattersFlag(rhs.theOrderMattersFlag),
     theMinNumberOfValues(rhs.theMinNumberOfValues),
     theMaxNumberOfValues(rhs.theMaxNumberOfValues)
 {
 }

Member Function Documentation

◆ addValue()

bool ossimStringListProperty::addValue ( const ossimString & value )

Definition at line 150 of file ossimStringListProperty.cpp.

References canAddValue(), and theValueList.

Referenced by setValue().

 {
    bool result = true;
    
    if(canAddValue(value))
    {
       theValueList.push_back(value);
    }
    else
    {
       result = false;
    }
 
    return result;
 }

◆ assign()

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

virtual

Reimplemented from ossimProperty.

Definition at line 42 of file ossimStringListProperty.cpp.

References ossimProperty::assign(), theConstraintList, theMaxNumberOfValues, theMinNumberOfValues, theOrderMattersFlag, theUniqueFlag, and theValueList.

 {
    ossimProperty::assign(rhs);
 
    const ossimStringListProperty *rhsPtr = dynamic_cast<const ossimStringListProperty*>(&rhs);
    if(rhsPtr)
    {
       theValueList         = rhsPtr->theValueList;
       theConstraintList    = rhsPtr->theConstraintList;
       theUniqueFlag        = rhsPtr->theUniqueFlag;
       theOrderMattersFlag  = rhsPtr->theOrderMattersFlag;
       theMinNumberOfValues = rhsPtr->theMinNumberOfValues;
       theMaxNumberOfValues = rhsPtr->theMaxNumberOfValues;
    }
 
    return *this;
 }

◆ canAddValue()

bool ossimStringListProperty::canAddValue ( const ossimString & value ) const

protected

Definition at line 234 of file ossimStringListProperty.cpp.

References findValueInConstraintList(), findValueInValueList(), hasConstraints(), and theUniqueFlag.

Referenced by addValue(), and setValueAt().

 {
    bool result = true;
 
    if(hasConstraints())
    {
       if(findValueInConstraintList(value))
       {
          if(theUniqueFlag)
          {
             if(findValueInValueList(value))
             {
                result = false;
             }
          }
       }
       else
       {
          result = false;
       }
    }
 
    return result;
 }

◆ clearValueList()

void ossimStringListProperty::clearValueList ( )

Definition at line 113 of file ossimStringListProperty.cpp.

References theValueList.

Referenced by setValue().

 {
    theValueList.clear();
 }

◆ dup()

ossimObject * ossimStringListProperty::dup ( ) const

virtual

Reimplemented from ossimObject.

Definition at line 37 of file ossimStringListProperty.cpp.

References ossimStringListProperty().

 {
    return new ossimStringListProperty(*this);
 }

◆ findValueInConstraintList()

bool ossimStringListProperty::findValueInConstraintList ( const ossimString & value ) const

protected

Definition at line 220 of file ossimStringListProperty.cpp.

References theConstraintList.

Referenced by canAddValue().

 {
    return (std::find(theConstraintList.begin(),
                      theConstraintList.end(),
                      value)!=theConstraintList.end());
 }

◆ findValueInValueList()

bool ossimStringListProperty::findValueInValueList ( const ossimString & value ) const

protected

Definition at line 227 of file ossimStringListProperty.cpp.

References theConstraintList, and theValueList.

Referenced by canAddValue().

 {
    return (std::find(theValueList.begin(),
                      theValueList.end(),
                      value)!=theConstraintList.end());
 }

◆ getConstraintAt()

ossimString ossimStringListProperty::getConstraintAt ( ossim_uint32 idx ) const

Definition at line 176 of file ossimStringListProperty.cpp.

References theConstraintList.

 {
    if(idx < theConstraintList.size())
    {
       return theConstraintList[(int)idx];
    }
 
    return ossimString("");
 }

◆ getNumberOfContraints()

ossim_uint32 ossimStringListProperty::getNumberOfContraints ( ) const

Definition at line 171 of file ossimStringListProperty.cpp.

References theConstraintList.

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

◆ getNumberOfValues()

ossim_uint32 ossimStringListProperty::getNumberOfValues ( ) const

Definition at line 166 of file ossimStringListProperty.cpp.

References theValueList.

Referenced by getValueAt(), and setValueAt().

 {
    return (int)theValueList.size();
 }

◆ getNumberofValuesBounds()

void ossimStringListProperty::getNumberofValuesBounds	(	int &	minNumber,
		int &	maxNumber
	)		const

Definition at line 213 of file ossimStringListProperty.cpp.

References theMaxNumberOfValues, and theMinNumberOfValues.

 {
    minNumber = theMinNumberOfValues;
    maxNumber = theMaxNumberOfValues;
 }

◆ getValueAt()

ossimString ossimStringListProperty::getValueAt ( int idx ) const

Definition at line 118 of file ossimStringListProperty.cpp.

References getNumberOfValues(), and theValueList.

 {
    if((idx >= 0)&&
       (idx < (int)getNumberOfValues()))
    {
       return theValueList[idx];
    }
    
    return ossimString("");;
 }

◆ hasConstraints()

bool ossimStringListProperty::hasConstraints ( ) const

Definition at line 191 of file ossimStringListProperty.cpp.

References theConstraintList.

Referenced by canAddValue().

 {
    return (theConstraintList.size()>0);
 }

◆ setConstraints()

void ossimStringListProperty::setConstraints ( const std::vector< ossimString > & constraints )

Definition at line 186 of file ossimStringListProperty.cpp.

References theConstraintList.

 {
    theConstraintList =  constraints;
 }

◆ setNumberOfValuesBounds()

void ossimStringListProperty::setNumberOfValuesBounds	(	int	minNumber,
		int	maxNumber
	)

You can specify how many values are allowed in the value list If any of the values are less than 0 then now constraints are placed on that value. So if the min was < 0 then there is no minumum number of values. If the max is < 0 then there is no maximum number of values.

Definition at line 206 of file ossimStringListProperty.cpp.

References theMaxNumberOfValues, and theMinNumberOfValues.

 {
    theMinNumberOfValues = minNumber;
    theMaxNumberOfValues = maxNumber;
 }

◆ setOrderMattersFlag()

void ossimStringListProperty::setOrderMattersFlag ( bool flag )

Definition at line 201 of file ossimStringListProperty.cpp.

References theOrderMattersFlag.

 {
    theOrderMattersFlag = flag;
 }

◆ setUniqueFlag()

void ossimStringListProperty::setUniqueFlag ( bool flag )

Definition at line 196 of file ossimStringListProperty.cpp.

References theUniqueFlag.

 {
    theUniqueFlag = flag;
 }

◆ setValue()

bool ossimStringListProperty::setValue ( const ossimString & value )

virtual

Implements ossimProperty.

Definition at line 60 of file ossimStringListProperty.cpp.

References addValue(), clearValueList(), ossimKeywordlist::find(), ossimKeywordlist::getSubstringKeyList(), ossimKeywordlist::parseStream(), and ossimString::toString().

 {
    ossimKeywordlist kwl;
    std::istringstream in(value);
    bool result = true;
    
    if(kwl.parseStream(in))
    {
       int idx = 0;
       std::vector<ossimString> keys =
          kwl.getSubstringKeyList( "^([0-9]*" );
       
       std::vector<int> theNumberList(keys.size());
       for(idx = 0; idx < (int)theNumberList.size();++idx)
       {
          theNumberList[idx] = keys[idx].toInt();
       }
       std::sort(theNumberList.begin(), theNumberList.end());
       clearValueList();
       for(idx = 0; idx < (int)theNumberList.size(); ++idx)
       {
          const char* temp = kwl.find(ossimString::toString(theNumberList[idx]));
 
          if(temp)
          {
             addValue(temp);
          }
       }
    }
    else
    {
       result = false;
    }
 
    return result;
 }

◆ setValueAt()

bool ossimStringListProperty::setValueAt	(	int	idx,
		const ossimString &	value
	)

Definition at line 129 of file ossimStringListProperty.cpp.

References canAddValue(), getNumberOfValues(), and theValueList.

 {
    bool result = true;
    
    if(canAddValue(value))
    {
       if((idx < (int)getNumberOfValues())&&
          (idx >= 0))
       {
          theValueList[idx] = value;
       }
    }
    else
    {
       result = false;
    }
    return result;
    
 }

◆ valueToString()

void ossimStringListProperty::valueToString ( ossimString & valueResult ) const

virtual

Implements ossimProperty.

Definition at line 97 of file ossimStringListProperty.cpp.

References ossimKeywordlist::add(), theValueList, ossimKeywordlist::toString(), and ossimString::toString().

 {
    ossimKeywordlist kwl;
    int idx = 0;
 
    for(idx = 0; idx < (int)theValueList.size(); ++idx)
    {
       kwl.add(ossimString::toString(idx).c_str(),
               theValueList[idx],
               true);
    }
    
    valueResult = kwl.toString();
 }

Member Data Documentation

◆ theConstraintList

std::vector<ossimString> ossimStringListProperty::theConstraintList

protected

Definition at line 54 of file ossimStringListProperty.h.

Referenced by assign(), findValueInConstraintList(), findValueInValueList(), getConstraintAt(), getNumberOfContraints(), hasConstraints(), and setConstraints().

◆ theMaxNumberOfValues

int ossimStringListProperty::theMaxNumberOfValues

protected

Definition at line 58 of file ossimStringListProperty.h.

Referenced by assign(), getNumberofValuesBounds(), and setNumberOfValuesBounds().

◆ theMinNumberOfValues

int ossimStringListProperty::theMinNumberOfValues

protected

Definition at line 57 of file ossimStringListProperty.h.

Referenced by assign(), getNumberofValuesBounds(), and setNumberOfValuesBounds().

◆ theOrderMattersFlag

bool ossimStringListProperty::theOrderMattersFlag

protected

Definition at line 56 of file ossimStringListProperty.h.

Referenced by assign(), and setOrderMattersFlag().

◆ theUniqueFlag

bool ossimStringListProperty::theUniqueFlag

protected

Definition at line 55 of file ossimStringListProperty.h.

Referenced by assign(), canAddValue(), and setUniqueFlag().

◆ theValueList

std::vector<ossimString> ossimStringListProperty::theValueList

protected

Definition at line 53 of file ossimStringListProperty.h.

Referenced by addValue(), assign(), clearValueList(), findValueInValueList(), getNumberOfValues(), getValueAt(), setValueAt(), and valueToString().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimStringListProperty() [1/2]

◆ ossimStringListProperty() [2/2]

Member Function Documentation

◆ addValue()

◆ assign()

◆ canAddValue()

◆ clearValueList()

◆ dup()

◆ findValueInConstraintList()

◆ findValueInValueList()

◆ getConstraintAt()

◆ getNumberOfContraints()

◆ getNumberOfValues()

◆ getNumberofValuesBounds()

◆ getValueAt()

◆ hasConstraints()

◆ setConstraints()

◆ setNumberOfValuesBounds()

◆ setOrderMattersFlag()

◆ setUniqueFlag()

◆ setValue()

◆ setValueAt()

◆ valueToString()

Member Data Documentation

◆ theConstraintList

◆ theMaxNumberOfValues

◆ theMinNumberOfValues

◆ theOrderMattersFlag

◆ theUniqueFlag

◆ theValueList