Gene Selkov, Jr. > Finnigan-0.0206d > Finnigan::GenericDataHeader

Download:
Finnigan-0.0206d.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.0206   Source  

NAME ^

Finnigan::GenericDataHeader -- a decoder for GenericDataHeader -- a key to decoding generic data records

SYNOPSIS ^

  use Finnigan;
  my $h = Finnigan::GenericDataHeader->decode(\*INPUT);
  say $h->n;
  say $h->dump;

DESCRIPTION ^

GenericDataHeader drives the decoding of a generic record. It stores a list of GenericDataDescriptor objects, each describing a field in the record.

METHODS

decode($stream)

The constructor method

n

Get the number of fields in each record

fields

Get the list of Finnigan::GenericDataDescriptor objects. Each descriptor object corresponds to a field in the GenericRecord structure to be decoded with this header.

labels

Get the list of descriptor labels in the order they occur in the header

field_templates

Get the list of unpack templates for the entire record in the form that can be passed to Finnigan::Decoder.

ordered_field_templates

Get the list of unpack templates whose keys are tagged with ordinal numbers to disambiguate possible duplicate keys and to preserve the order of fields. This is necessary for decoding the InstrumentLogRecord structures.

SEE ALSO ^

Finnigan::GenericDataDescriptor

Finnigan::GenericRecord

AUTHOR ^

Gene Selkov, <selkovjr@gmail.com>

COPYRIGHT AND LICENSE ^

Copyright (C) 2010 by Gene Selkov

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10.0 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: