Rogue Wave Views
Maps Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvFeatureAttributeInfo Class Reference

This class is used to store the names and types of map attributes. More...

#include <ilviews/maps/attrprop.h>

Public Member Functions

 IlvFeatureAttributeInfo (IlUInt count, const char *const *attributeNames, const IlvMapClassInfo *const *attributeClasses, const IlBoolean *nullable)
 Creates a new IlvFeatureAttributeInfo with the specified attribute names and classes. More...
 
 IlvFeatureAttributeInfo (const IlvFeatureAttributeInfo &source)
 Creates a new IlvFeatureAttributeInfo by copying an existing one. More...
 
 IlvFeatureAttributeInfo (IlvInputFile &file)
 Creates a new IlvFeatureAttributeInfo from an IlvInputFile. More...
 
IlvFeatureAttributeInfocopy () const
 Copies the property. More...
 
const IlvMapClassInfo * getAttributeClass (IlUInt i) const
 Returns the class of the attribute specified by the index i. More...
 
const char * getAttributeName (IlUInt i) const
 Returns the name of the attribute specified by the index i. More...
 
const IlvMapClassInfo *const * getAttributesClasses () const
 Returns the classes of the attributes. More...
 
IlUInt getAttributesCount () const
 Returns the count of attributes. More...
 
const char *const * getAttributesNames (IlUInt &count) const
 Returns the names of the attributes. More...
 
IlBoolean isNullable (int i) const
 Checks if an attribute is nullable. More...
 
void lock ()
 Locks the object. More...
 
void unLock ()
 Unlocks the object. More...
 
void write (IlvOutputFile &output) const
 Writes the object to an IlvOutputFile. More...
 

Detailed Description

This class is used to store the names and types of map attributes.

Library: ilvmaps

It is generally used with an IlvAttributeProperty.

Constructor & Destructor Documentation

IlvFeatureAttributeInfo::IlvFeatureAttributeInfo ( IlUInt  count,
const char *const *  attributeNames,
const IlvMapClassInfo *const *  attributeClasses,
const IlBoolean nullable 
)

Creates a new IlvFeatureAttributeInfo with the specified attribute names and classes.

Parameters
countThe number of attributes.
attributeNamesThe names of the attributes.
attributeClassesThe classes of the attributes.
nullableA Boolean array that takes the IlTrue value for the attributes that can have a null value (these attributes are optional).
IlvFeatureAttributeInfo::IlvFeatureAttributeInfo ( const IlvFeatureAttributeInfo source)

Creates a new IlvFeatureAttributeInfo by copying an existing one.

Parameters
sourceThe feature attribute info to be copied.
IlvFeatureAttributeInfo::IlvFeatureAttributeInfo ( IlvInputFile file)

Creates a new IlvFeatureAttributeInfo from an IlvInputFile.

Parameters
fileThe input file.

Member Function Documentation

IlvFeatureAttributeInfo* IlvFeatureAttributeInfo::copy ( ) const

Copies the property.

Returns
The copied IlvFeatureAttributeInfo.
const IlvMapClassInfo* IlvFeatureAttributeInfo::getAttributeClass ( IlUInt  i) const

Returns the class of the attribute specified by the index i.

Parameters
iThe index of the attribute.
Returns
The corresponding IlvMapClassInfo.
const char* IlvFeatureAttributeInfo::getAttributeName ( IlUInt  i) const

Returns the name of the attribute specified by the index i.

Parameters
iThe index of the attribute.
Returns
The name of the attribute at index i.
const IlvMapClassInfo* const* IlvFeatureAttributeInfo::getAttributesClasses ( ) const

Returns the classes of the attributes.

Returns
The array of IlvMapClassInfo.
IlUInt IlvFeatureAttributeInfo::getAttributesCount ( ) const

Returns the count of attributes.

Returns
The count of attributes.
const char* const* IlvFeatureAttributeInfo::getAttributesNames ( IlUInt count) const

Returns the names of the attributes.

Parameters
countThe returned number of attributes.
Returns
The array of attributes.
IlBoolean IlvFeatureAttributeInfo::isNullable ( int  i) const

Checks if an attribute is nullable.

Returns IlTrue if the attribute specified by the index i can have a null value.

Parameters
iThe index of the attribute.
Returns
IlTrue if the attribute can have a null value, IlFalse otherwise.
void IlvFeatureAttributeInfo::lock ( )

Locks the object.

Locks the object by incrementing the lock count.

void IlvFeatureAttributeInfo::unLock ( )

Unlocks the object.

Decrements the lock counts and deletes the object when the lock count has fallen to 0.

void IlvFeatureAttributeInfo::write ( IlvOutputFile output) const

Writes the object to an IlvOutputFile.

Parameters
outputThe output file.

© Copyright 2016, 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.