.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "LLNL::LAVA::Options 3"
.TH LLNL::LAVA::Options 3 "2011-06-27" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
LLNL::LAVA::Options \- A way to enforce options and parameters for functions 
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&  use LLNL::LAVA::Options ":options"; 
\&    # optionRequired, 
\&    # optionWithDefault, 
\&    # loadOptionsFromFile, 
\&    # writeOptionsToFile
.Ve
.PP
.Vb 1
\&  # A couple easy examples
.Ve
.PP
.Vb 7
\&  # Parameter hash is a reference to name->value pairs
\&  my $optionValue = optionRequired(\e%options, "option_name");
\&  my $optionValue = optionRequired(\e%options, "option_name", 
\&    $informativeErrorMessage);
\&  my @listValue = optionRequired(\e%options, "same_named_options");
\&  my @listValue = optionRequired(\e%options, "same_named_options",
\&    $informativeErrorMessage);
.Ve
.PP
.Vb 3
\&  my $optionValue = optionWithDefault(\e%options, "option_name", $defaultValue);
\&  my @listValue = optionWithDefault(\e%options, "same_named_options", 
\&    @myDefaultValues);
.Ve
.PP
.Vb 10
\&  # Option file functions
\&  #
\&  # Pre-existing option values take precedence when there is a conflict.
\&  # This is intended to make it simple for command-line arguments to override
\&  # file-defined option values
\&  # Yeah, this might not do FULL command-line representation, but it should
\&  # be good enough to start with :)
\&  #
\&  # App::Options is promising as an alternative to the file IO part of this,
\&  # but its documentation is a little opaque for now.
.Ve
.PP
.Vb 3
\&  # Pass in a hash ref which will be modified
\&  # If you already know the file name to read from, you can specify it
\&  loadOptionsFromFile(\e%options, $optionsFileName);
.Ve
.PP
.Vb 4
\&  # If the file name is one of the options, you can use this style where the
\&  # hash ref MUST CONTAIN the key/value "option_file" which is the file 
\&  # name to read.
\&  loadOptionsFromFile(\e%options);
.Ve
.PP
.Vb 2
\&  # Write an options ML file
\&  writeOptionsToFile(\e%options, $outputFileName);
.Ve
.PP
.Vb 5
\&  # You can also specify write mode if you want, valid modes are:
\&  #   0 - No stomping of file (default if not supplied)
\&  #   1 - [NOT IMPLEMENTED] append to file
\&  #   2 - Stop existing file if it's there
\&  writeOptionsToFile(\e%options, $outputFileName, $writeMode);
.Ve
.PP
.Vb 7
\&  # Sample option file
\&  <option_set>
\&    <sequence_file>virus_sequence.fasta</sequence_file>
\&    <database_file>search_me.fasta</database_file>
\&    <word_size>7</word_size>
\&    <output_file>answer.out</output_file>
\&  </option_set>
.Ve
.SH "EXAMPLES"
.IX Header "EXAMPLES"
See Synopsis
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
LLNL::LAVA::Options defines functions that many perl scripts need
.SH "APPENDIX"
.IX Header "APPENDIX"
The following documentation describes the functions in this package
.Sh "optionRequired"
.IX Subsection "optionRequired"
.Vb 10
\& Usage     : my $optionValue = optionRequired(\e%params, "option_name");
\&             my $optionValue = optionRequired(\e%params, "option_name", 
\&               "informative error message");
\& Function  : Will retrieve the value of the element from the passed-in hash
\&             reference.  If there is no element of that name, or if the value 
\&             is blank, then will Carp out. 
\& Arguments : String - the element name to retrieve the value of
\&             String - error message to show if parameter loading fails 
\& Example   : See Usage
\& Returns   : String - value of the argument
.Ve
.Sh "optionWithDefault"
.IX Subsection "optionWithDefault"
.Vb 9
\& Usage     : my $optionValue = optionWithDefault(\e%params, "option_name", 
\&               "default value");
\& Function  : Will retrieve the value of the element from the passed-in hash
\&             reference.  If there is no element of that name, or if the value 
\&             is blank, then the default parameter value will be returned. 
\& Arguments : String - element name to retrieve the value of
\&             String - default to return in absence of a value
\& Example   : See Usage
\& Returns   : String - value of the element, or the default value
.Ve
.Sh "loadOptionsFromFile"
.IX Subsection "loadOptionsFromFile"
.Vb 13
\& Usage     : loadOptionsFromFile(\e%options, $fileName); 
\&             loadOptionsFromFile(\e%options); # This way is OK when %options 
\&               # has an "option_file" key with the filename as value
\& Function  : Loads an option file, filling keys and values into the
\&             option hash whenever the options weren't previously defined.
\&             This function will silently do nothing if an option file is not
\&             specified properly - this is so you don't need to include more
\&             logic to only check file options when available.  Sorry if it
\&             causes you heartburn
\& Arguments : Hash ref - Hash of name/value pairs 
\&             String (optional with caveat) - File name to read
\& Example   : See Usage
\& Returns   : <n/a>
.Ve
.Sh "writeOptionsToFile"
.IX Subsection "writeOptionsToFile"
.Vb 10
\& Usage     : writeOptionsToFile(\e%options, $fileName, $writeMode); 
\& Function  : Writes an option file, printing name/value pairs as XML elements 
\& Arguments : Hash ref - Hash of name/value pairs 
\&             String - File name to write
\&             Integer (optional) - Write mode, valid values are:
\&                 0 - No stomping of file (default if not supplied)
\&                 1 - [NOT IMPLEMENTED] append to file
\&                 2 - Stop existing file if it's there
\& Example   : See Usage
\& Returns   : <n/a>
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Clinton Torres (clinton.torres@llnl.gov)
.SH "SEE ALSO"
.IX Header "SEE ALSO"