#include <ossimStringProperty.h>

Inheritance diagram for ossimStringProperty:

Public Member Functions
	ossimStringProperty (const ossimString &name=ossimString(""), const ossimString &value=ossimString(""), bool editableFlag=true, const std::vector< ossimString > &constraintList=std::vector< ossimString >())

	ossimStringProperty (const ossimStringProperty &rhs)

virtual ossimObject *	dup () const

virtual const ossimProperty &	assign (const ossimProperty &rhs)

void	setEditableFlag (bool flag)

bool	getEditableFlag () const

bool	isEditable () const

void	clearConstraints ()

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

void	addConstraint (const ossimString &value)

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

bool	hasConstraints () const

virtual bool	setValue (const ossimString &value)

virtual void	valueToString (ossimString &valueResult) 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

bool	theEditableFlag

std::vector< ossimString >	theConstraints

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) }

Protected Member Functions inherited from ossimProperty
virtual	~ossimProperty ()

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

Definition at line 15 of file ossimStringProperty.h.

Constructor & Destructor Documentation

◆ ossimStringProperty() [1/2]

ossimStringProperty::ossimStringProperty	(	const ossimString &	name = `ossimString("")`,
		const ossimString &	value = `ossimString("")`,
		bool	editableFlag = `true`,
		const std::vector< ossimString > &	constraintList = `std::vector<ossimString>()`
	)

Definition at line 14 of file ossimStringProperty.cpp.

Referenced by dup().

    :ossimProperty(name),
     theValue(value),
     theEditableFlag(editableFlag),
     theConstraints(constraintList)
 {
 }

◆ ossimStringProperty() [2/2]

ossimStringProperty::ossimStringProperty ( const ossimStringProperty & rhs )

Definition at line 25 of file ossimStringProperty.cpp.

    :ossimProperty(rhs),
     theValue(rhs.theValue),
     theEditableFlag(rhs.theEditableFlag),
     theConstraints(rhs.theConstraints)
 {
 }

Member Function Documentation

◆ addConstraint()

void ossimStringProperty::addConstraint ( const ossimString & value )

Definition at line 82 of file ossimStringProperty.cpp.

References theConstraints.

Referenced by ossimNitfWriter::getProperty(), ossimCastTileSourceFilter::getProperty(), ossimNitfFileHeaderV2_X::getProperty(), ossimTiffWriter::getProperty(), ossimNitfFileHeaderV2_1::getProperty(), and ossimImageHandler::getProperty().

 {
    theConstraints.push_back(value);
 }

◆ assign()

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

virtual

Reimplemented from ossimProperty.

Definition at line 38 of file ossimStringProperty.cpp.

References ossimProperty::assign(), theConstraints, theEditableFlag, theValue, and ossimProperty::valueToString().

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

◆ clearConstraints()

void ossimStringProperty::clearConstraints ( )

Clears the constraints for this string. You can constrain it to a string list by calling setConstraints.

Definition at line 72 of file ossimStringProperty.cpp.

References theConstraints.

 {
    theConstraints.clear();
 }

◆ dup()

ossimObject * ossimStringProperty::dup ( ) const

virtual

Duplicates the object and returns a new one

Reimplemented from ossimObject.

Definition at line 33 of file ossimStringProperty.cpp.

References ossimStringProperty().

 {
    return new ossimStringProperty(*this);
 }

◆ getConstraints()

const std::vector< ossimString > & ossimStringProperty::getConstraints ( ) const

Definition at line 87 of file ossimStringProperty.cpp.

References theConstraints.

Referenced by ossimImageHandlerRegistry::printReaderProps(), and ossimImageWriterFactoryRegistry::printWriterProps().

 {
    return theConstraints;
 }

◆ getEditableFlag()

bool ossimStringProperty::getEditableFlag ( ) const

Definition at line 61 of file ossimStringProperty.cpp.

References theEditableFlag.

Referenced by isEditable().

 {
    return theEditableFlag;
 }

◆ hasConstraints()

bool ossimStringProperty::hasConstraints ( ) const

Definition at line 92 of file ossimStringProperty.cpp.

References theConstraints.

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

◆ isEditable()

bool ossimStringProperty::isEditable ( ) const

Definition at line 66 of file ossimStringProperty.cpp.

References getEditableFlag().

 {
    return (getEditableFlag() == true);
 }

◆ setConstraints()

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

Sets the constraints for this property. If the editable flag is present then this says the editing is not readonly and one can hand type the value in without only selecting from a choice list.

Definition at line 77 of file ossimStringProperty.cpp.

References theConstraints.

Referenced by ossimImageFileWriter::getProperty().

 {
    theConstraints = constraintList;
 }

◆ setEditableFlag()

void ossimStringProperty::setEditableFlag ( bool flag )

Definition at line 56 of file ossimStringProperty.cpp.

References theEditableFlag.

Referenced by ossimImageHandler::getProperty().

 {
    theEditableFlag = flag;
 }

◆ setValue()

bool ossimStringProperty::setValue ( const ossimString & value )

virtual

will try to set the value. If the constraints are set it will make sure that the value is in the list and if its not then it will return false

Implements ossimProperty.

Definition at line 97 of file ossimStringProperty.cpp.

References theConstraints, and theValue.

 {
    bool result = true;
    
    if(theConstraints.size() > 0)
    {
       if(std::find(theConstraints.begin(),
                    theConstraints.end(),
                    value)
                     != theConstraints.end())
       {
          theValue = value;
       }
       else
       {
          result = false;
       }
    }
    else
    {
       theValue = value;
    }
 
    return result;
 }

◆ valueToString()

void ossimStringProperty::valueToString ( ossimString & valueResult ) const

virtual

Implements ossimProperty.

Definition at line 123 of file ossimStringProperty.cpp.

References theValue.

Referenced by ossimTiffWriter::setProperty().

 {
    valueResult = theValue;
 }

Member Data Documentation

◆ theConstraints

std::vector<ossimString> ossimStringProperty::theConstraints

protected

Definition at line 68 of file ossimStringProperty.h.

Referenced by addConstraint(), assign(), clearConstraints(), getConstraints(), hasConstraints(), setConstraints(), and setValue().

◆ theEditableFlag

bool ossimStringProperty::theEditableFlag

protected

Definition at line 67 of file ossimStringProperty.h.

Referenced by assign(), getEditableFlag(), and setEditableFlag().

◆ theValue

ossimString ossimStringProperty::theValue

protected

Definition at line 66 of file ossimStringProperty.h.

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ossimStringProperty() [1/2]

◆ ossimStringProperty() [2/2]

Member Function Documentation

◆ addConstraint()

◆ assign()

◆ clearConstraints()

◆ dup()

◆ getConstraints()

◆ getEditableFlag()

◆ hasConstraints()

◆ isEditable()

◆ setConstraints()

◆ setEditableFlag()

◆ setValue()

◆ valueToString()

Member Data Documentation

◆ theConstraints

◆ theEditableFlag

◆ theValue