Eric A. Zarko > Geo-TigerLine-0.03 > Geo::TigerLine::Record::5

Download:
Geo-TigerLine-0.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.03   Source  

NAME ^

Geo::TigerLine::Record::5 - TIGER/Line 2006 Complete Chain Feature Identifiers

SYNOPSIS ^

  use Geo::TigerLine::Record::5;

  @records = Geo::TigerLine::Record::5->parse_file($fh);
  @records = Geo::TigerLine::Record::5->parse_file($fh, \&callback);

  $record = Geo::TigerLine::Record::5->new(\%fields);

  $record->rt();
  $record->version();
  $record->file();
  $record->feat();
  $record->fedirp();
  $record->fename();
  $record->fetype();
  $record->fedirs();

DESCRIPTION ^

This is a class representing record type 5 of the TIGER/Line 2006 census geographic database. Each object is one record. It also contains methods to parse TIGER/Line record type 5 files and turn them into objects.

This is intended as an intermediate format between pulling the raw data out of the simplistic TIGER/Line data files into something more sophisticated (a process you should only have to do once). As such, it's not very fast, but its careful, easy to use and performs some verifications on the data being read.

As this class is autogenerated by mk_parsers, think before you modify this file. It's OO, so consider sub-classing instead.

Accessors

These are simple get/set accessors for each field of a record generated from the TIGER/Line 2006 data dictionary. They perform some data validation.

rt
    $data = $record->rt();
    $record->rt($data);

Record Type.

Expects alphanumeric data of no more than 1 characters. $data cannot be blank and should be left justified.

version
    $data = $record->version();
    $record->version($data);

Version Number.

Expects numeric data of no more than 4 characters. $data cannot be blank and should be left justified.

file
    $data = $record->file();
    $record->file($data);

File Code.

Expects numeric data of no more than 5 characters. $data cannot be blank and should be left justified.

feat
    $data = $record->feat();
    $record->feat($data);

Line Name Identification Number.

Expects numeric data of no more than 8 characters. $data cannot be blank and should be right justified.

fedirp
    $data = $record->fedirp();
    $record->fedirp($data);

Feature Direction, Prefix.

Expects alphanumeric data of no more than 2 characters. $data can be blank and should be left justified.

fename
    $data = $record->fename();
    $record->fename($data);

Feature Name.

Expects alphanumeric data of no more than 30 characters. $data can be blank and should be left justified.

fetype
    $data = $record->fetype();
    $record->fetype($data);

Feature Type.

Expects alphanumeric data of no more than 4 characters. $data can be blank and should be left justified.

fedirs
    $data = $record->fedirs();
    $record->fedirs($data);

Feature Direction, Suffix.

Expects alphanumeric data of no more than 2 characters. $data can be blank and should be left justified.

Data dictionary

This is the original TIGER/Line 2006 data dictionary from which this class was generated.

    Record Type 5 - Complete Chain Feature Identifiers
    
    Field   BV  Fmt Type Beg End Len Description
    RT      No   L   A    1   1   1  Record Type
    VERSION No   L   N    2   5   4  Version Number
    FILE    No   L   N    6  10   5  File Code
    FEAT    No   R   N   11  18   8  Line Name Identification Number
    FEDIRP  Yes  L   A   19  20   2  Feature Direction, Prefix
    FENAME  Yes  L   A   21  50  30  Feature Name
    FETYPE  Yes  L   A   51  54   4  Feature Type
    FEDIRS  Yes  L   A   55  56   2  Feature Direction, Suffix

AUTHOR ^

Michael G Schwern <schwern@pobox.com>

SEE ALSO ^

Geo::TigerLine, mk_parsers

syntax highlighting: