IlvProjectionInterface Class Reference

This class provides facilities to get run-time information about the parameters of a projection, and to set or modify their values. More...

#include <ilviews/maps/projection/projitf.h>

Inheritance diagram for IlvProjectionInterface:

Public Member Functions
virtual void	getAccessors (const IlvSymbol *const **accessors, const IlvValueTypeClass *const **types, IlUInt &count) const
	Returns the list of accessors of a projection. More...
virtual const IlvValueTypeClass *	getValueType (const IlvSymbol *valueName) const
	Returns the type of the accessor parameter. More...
IlBoolean	isValueReadOnly (const IlvSymbol *valueName) const
virtual IlvValue &	queryValue (IlvValue &value) const
	Returns the value of a projection parameter in value. More...

Detailed Description

This class provides facilities to get run-time information about the parameters of a projection, and to set or modify their values.

It can be used, for example, to create projection editors in a map application.
To get the projection interface of a projection instance, use the IlvProjection::getInterface method.

See also

IlvProjection, IlvProjectionDictionary, IlvProjectionClassInfo, IlvValue. Library: ilvmaps

Member Function Documentation

getAccessors()

virtual void IlvProjectionInterface::getAccessors ( const IlvSymbol *const **  accessors, const IlvValueTypeClass *const **  types, IlUInt &  count  ) const

virtual

Returns the list of accessors of a projection.

Accessors is the resulting array of symbols. Each symbol is the name of a projection parameter types is the array of the types of accessors, count is the number of accessors.
The existing types for accessors that are relevant for a projection parameter are the following:

• IlvValueIntType
• IlvValueUIntType
• IlvValueStringType
• IlvValueBooleanType
• IlvValueDoubleType

Parameters

accessors	The resulting array of symbols.
types	The array of the types of accessors.
count	The number of accessors.

getValueType()

virtual const IlvValueTypeClass* IlvProjectionInterface::getValueType ( const IlvSymbol *  valueName ) const

virtual

Returns the type of the accessor parameter.

If parameter is not an accessor of the projection class, the function returns a null pointer.

Parameters

valueName

The name of the parameter to fetch.

Returns

The type of the accessor.

isValueReadOnly()

IlBoolean IlvProjectionInterface::isValueReadOnly

(

const IlvSymbol *

valueName

)

const

Returns IlTrue if the parameter valueName cannot be changed.

Parameters

valueName

The parameter to check.

Returns

IlTrue if the value is read only, IlFalse otherwise.

queryValue()

virtual IlvValue& IlvProjectionInterface::queryValue ( IlvValue &  value ) const

virtual

Returns the value of a projection parameter in value.

The queryValue method can be used in the following way:

   IlvValue arg("centralParallel");
   char * label = (char*)projection->queryValue(arg);

Note

See the Rogue Wave Views Foundation Package Reference Manual for complete information on the IlvValue class.

Parameters

value

The projection parameter.

Returns

The value of the parameter.

Reimplemented from IlvValueInterface.