rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
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>

Inherits IlvValueInterface.

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 IlvValueTypeClassgetValueType (const IlvSymbol *valueName) const
 Returns the type of the accessor parameter. More...
 
IlBoolean isValueReadOnly (const IlvSymbol *valueName) const
 
virtual IlvValuequeryValue (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

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
accessorsThe resulting array of symbols.
typesThe array of the types of accessors.
countThe number of accessors.
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
valueNameThe name of the parameter to fetch.
Returns
The type of the accessor.
IlBoolean IlvProjectionInterface::isValueReadOnly ( const IlvSymbol valueName) const

Returns IlTrue if the parameter valueName cannot be changed.

Parameters
valueNameThe parameter to check.
Returns
IlTrue if the value is read only, IlFalse otherwise.
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);
Warning
[note] See the Rogue Wave Views Foundation Package Reference Manual for complete information on the IlvValue class.
Parameters
valueThe projection parameter.
Returns
The value of the parameter.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.