source: branches/UKMO/r6232_tracer_advection/NEMOGCM/EXTERNAL/fcm/lib/Fcm/Keyword/Loader.pod @ 9295

Last change on this file since 9295 was 9295, checked in by jcastill, 3 years ago

Remove svn keywords

File size: 988 bytes
Line 
1=head1 NAME
2
3Fcm::Keyword::Loader
4
5=head1 SYNOPSIS
6
7    $loader->load_to($entries);
8
9=head1 DESCRIPTION
10
11This is an interface of a class that loads FCM keywords into a
12L<Fcm::Keyword::Entries|Fcm::Keyword::Entries> object.
13
14=head1 METHODS
15
16=over 4
17
18=item get_source()
19
20The name of the source where this loader loads its FCM keywords from.
21
22=item load_to($entries)
23
24Loads FCM keywords into $entries, which should be a
25L<Fcm::Keyword::Entries|Fcm::Keyword::Entries> object. Returns the number of
26successfully loaded entries.
27
28=back
29
30=head1 SEE ALSO
31
32L<Fcm::Keyword|Fcm::Keyword>,
33L<Fcm::Keyword::Entries|Fcm::Keyword::Entries>,
34L<Fcm::Keyword::Entry|Fcm::Keyword::Entry>,
35L<Fcm::Keyword::Loader::Config::Location|Fcm::Keyword::Loader::Config::Location>,
36L<Fcm::Keyword::Loader::Config::Revision|Fcm::Keyword::Loader::Config::Revision>,
37L<Fcm::Keyword::Loader::VC::Revision|Fcm::Keyword::Loader::VC::Revision>
38
39=head1 COPYRIGHT
40
41E<169> Crown copyright Met Office. All rights reserved.
42
43=cut
Note: See TracBrowser for help on using the repository browser.