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