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

Download:
Geo-TigerLine-0.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.03   Source  

NAME ^

Geo::TigerLine::Record::M - TIGER/Line 2006 Feature Spatial Metadata Record

SYNOPSIS ^

  use Geo::TigerLine::Record::M;

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

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

  $record->rt();
  $record->version();
  $record->tlid();
  $record->rtsq();
  $record->sourceid();
  $record->id();
  $record->idflag();
  $record->rs_m1();
  $record->rs_m2();
  $record->rs_m3();

DESCRIPTION ^

This is a class representing record type M of the TIGER/Line 2006 census geographic database. Each object is one record. It also contains methods to parse TIGER/Line record type M 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.

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

TIGER/Line ID, Permanent 1-Cell Number.

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

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

Record Sequence Number.

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

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

TIGER 1-Cell Source Code.

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

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

Identification Code.

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

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

Identification Code Flag.

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

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

Reserved Space M1.

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

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

Reserved Space M2.

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

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

Reserved Space M3.

Expects numeric data of no more than 23 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 M - Feature Spatial Metadata Record
    
    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 
    TLID       No   R   N     6   15 10  TIGER/Line ID, Permanent 1-Cell Number 
    RTSQ       No   R   N    16   18  3  Record Sequence Number 
    SOURCEID   Yes  L    A   19   28 10  TIGER 1-Cell Source Code 
    ID         Yes  L    A   29   46 18  Identification Code 
    IDFLAG     Yes  R    A   47   47  1  Identification Code Flag 
    RS-M1      Yes  L   N    48   65 18  Reserved Space M1 
    RS-M2      Yes  L    A   66   67  2  Reserved Space M2 
    RS-M3      Yes  L   N    68   90 23  Reserved Space M3 

AUTHOR ^

Michael G Schwern <schwern@pobox.com>

SEE ALSO ^

Geo::TigerLine, mk_parsers

syntax highlighting: