Quantum GIS API Documentation  1.8
Public Member Functions | Private Attributes
QgsField Class Reference

Encapsulate a field in an attribute table or data source. More...

#include <qgsfield.h>

List of all members.

Public Member Functions

 QgsField (QString name=QString(), QVariant::Type type=QVariant::Invalid, QString typeName=QString(), int len=0, int prec=0, QString comment=QString())
 Constructor.
 ~QgsField ()
 Destructor.
bool operator== (const QgsField &other) const
const QString & name () const
 Gets the name of the field.
QVariant::Type type () const
 Gets variant type of the field as it will be retrieved from data source.
const QString & typeName () const
 Gets the field type.
int length () const
 Gets the length of the field.
int precision () const
 Gets the precision of the field.
const QString & comment () const
 Returns the field comment.
void setName (const QString &nam)
 Set the field name.
void setType (QVariant::Type type)
 Set variant type.
void setTypeName (const QString &typ)
 Set the field type.
void setLength (int len)
 Set the field length.
void setPrecision (int prec)
 Set the field precision.
void setComment (const QString &comment)
 Set the field comment.

Private Attributes

QString mName
 Name.
QVariant::Type mType
 Variant type.
QString mTypeName
 Type name from provider.
int mLength
 Length.
int mPrecision
 Precision.
QString mComment
 Comment.

Detailed Description

Encapsulate a field in an attribute table or data source.

QgsField stores metadata about an attribute field, including name, type length, and if applicable, precision.

Definition at line 28 of file qgsfield.h.


Constructor & Destructor Documentation

QgsField::QgsField ( QString  name = QString(),
QVariant::Type  type = QVariant::Invalid,
QString  typeName = QString(),
int  len = 0,
int  prec = 0,
QString  comment = QString() 
)

Constructor.

Constructs a new QgsField object.

Parameters:
nameField name
typeField variant type, currently supported: String / Int / Double
typeNameField type (eg. char, varchar, text, int, serial, double). Field types are usually unique to the source and are stored exactly as returned from the data store.
lenField length
precField precision. Usually decimal places but may also be used in conjunction with other fields types (eg. variable character fields)
commentComment for the field

Definition at line 32 of file qgsfield.cpp.

Destructor.

Definition at line 39 of file qgsfield.cpp.


Member Function Documentation

const QString & QgsField::comment ( ) const

Returns the field comment.

Definition at line 74 of file qgsfield.cpp.

References mComment.

Referenced by QgsVectorLayer::metadata(), and setComment().

int QgsField::length ( ) const

Gets the length of the field.

Returns:
int containing the length of the field

Definition at line 64 of file qgsfield.cpp.

References mLength.

Referenced by QgsFieldValidator::fixup(), QgsVectorLayer::metadata(), QgsFieldValidator::QgsFieldValidator(), QgsVectorFileWriter::QgsVectorFileWriter(), QgsVectorDataProvider::supportedType(), and QgsFieldValidator::validate().

const QString & QgsField::name ( ) const
bool QgsField::operator== ( const QgsField other) const

Definition at line 43 of file qgsfield.cpp.

References mLength, mName, mPrecision, mType, and mTypeName.

int QgsField::precision ( ) const

Gets the precision of the field.

Not all field types have a related precision.

Returns:
int containing the precision or zero if not applicable to the field type.

Definition at line 69 of file qgsfield.cpp.

References mPrecision.

Referenced by QgsVectorLayer::metadata(), QgsFieldValidator::QgsFieldValidator(), and QgsVectorDataProvider::supportedType().

void QgsField::setComment ( const QString &  comment)

Set the field comment.

Definition at line 103 of file qgsfield.cpp.

References comment(), and mComment.

void QgsField::setLength ( int  len)

Set the field length.

Parameters:
lenLength of the field

Definition at line 94 of file qgsfield.cpp.

References mLength.

void QgsField::setName ( const QString &  nam)

Set the field name.

Parameters:
namName of the field

Definition at line 79 of file qgsfield.cpp.

References mName.

void QgsField::setPrecision ( int  prec)

Set the field precision.

Parameters:
precPrecision of the field

Definition at line 98 of file qgsfield.cpp.

References mPrecision.

void QgsField::setType ( QVariant::Type  type)

Set variant type.

Definition at line 84 of file qgsfield.cpp.

References mType, and type().

void QgsField::setTypeName ( const QString &  typ)

Set the field type.

Parameters:
typField type

Definition at line 89 of file qgsfield.cpp.

References mTypeName, and typeName().

QVariant::Type QgsField::type ( ) const
const QString & QgsField::typeName ( ) const

Gets the field type.

Field types vary depending on the data source. Examples are char, int, double, blob, geometry, etc. The type is stored exactly as the data store reports it, with no attenpt to standardize the value.

Returns:
QString containing the field type

Definition at line 59 of file qgsfield.cpp.

References mTypeName.

Referenced by QgsVectorLayer::metadata(), and setTypeName().


Member Data Documentation

QString QgsField::mComment [private]

Comment.

Definition at line 141 of file qgsfield.h.

Referenced by comment(), and setComment().

int QgsField::mLength [private]

Length.

Definition at line 135 of file qgsfield.h.

Referenced by length(), operator==(), and setLength().

QString QgsField::mName [private]

Name.

Definition at line 126 of file qgsfield.h.

Referenced by name(), operator==(), and setName().

int QgsField::mPrecision [private]

Precision.

Definition at line 138 of file qgsfield.h.

Referenced by operator==(), precision(), and setPrecision().

QVariant::Type QgsField::mType [private]

Variant type.

Definition at line 129 of file qgsfield.h.

Referenced by operator==(), setType(), and type().

QString QgsField::mTypeName [private]

Type name from provider.

Definition at line 132 of file qgsfield.h.

Referenced by operator==(), setTypeName(), and typeName().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines