.\" 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::TagHolder 3"
.TH LLNL::LAVA::TagHolder 3 "2011-06-27" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
LLNL::LAVA::TagHolder \- Generic name/value pair functionality with get/set 
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  # This is a trimmed down version of a tag library that was designed to
\&  # inter-operate with tag tables in a relational database.
.Ve
.PP
.Vb 3
\&  # Since we don't have to interact with a DB, the primary benefit of
\&  # using the TagHolder library is that it can cause a fatal run-time error
\&  # when a tag lookup fails.
.Ve
.PP
.Vb 1
\&  use LLNL::LAVA::TagHolder;
.Ve
.PP
.Vb 2
\&  # Empty initialization
\&  my $tagHolder = LLNL::LAVA::TagHolder->new();
.Ve
.PP
.Vb 4
\&  # Setting a tag value
\&  $tagHolder->setTag("foo", $fooValue);
\&  # Setting a tag value for non-scalars doesn't work, so use references
\&  $tagHolder->setTag("foo", \e@fooValues);
.Ve
.PP
.Vb 2
\&  # Get a tag's value 
\&  my $value = getTag("foo");
.Ve
.PP
.Vb 2
\&  # Returns $TRUE or $FALSE
\&  my $tagExists = $tagHolder->getTagExists("foo");
.Ve
.PP
.Vb 2
\&  # Get all tag names
\&  my @allTagNames = $tagHolder->getAllTagNames();
.Ve
.SH "EXAMPLES"
.IX Header "EXAMPLES"
See synopsis.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
TagHolder is a container for the tags of an object, held in
name/value pairs 
.SH "APPENDIX"
.IX Header "APPENDIX"
The following documentation describes the functions in this package
.Sh "new"
.IX Subsection "new"
.Vb 5
\& Usage     : my $tagHolder = LLNL::LAVA::TagHolder->new();
\& Function  : Creates a new LLNL::LAVA::TagHolder object 
\& Arguments : <n/a>
\& Example   : See Usage
\& Returns   : A new LLNL::LAVA::TagHolder
.Ve
.Sh "getTagExists"
.IX Subsection "getTagExists"
.Vb 6
\& Usage     : $existenceBool = $tagHolder->getTagExists("foo");
\& Function  : Probes the tagHolder for whether the requested name/value
\&             property exists 
\& Arguments : String - name of the property to test for
\& Example   : See Usage
\& Returns   : Bool ($TRUE or $FALSE) - whether the requested property exists
.Ve
.Sh "getTag"
.IX Subsection "getTag"
.Vb 5
\& Usage     : $fooValue = $tagHolder->getTag("foo"); 
\& Function  : Get the value of the requested property
\& Arguments : String - name of the property to find the value of
\& Example   : See Usage
\& Returns   : Scalar - value of the property
.Ve
.Sh "setTag"
.IX Subsection "setTag"
.Vb 7
\& Usage     : $storage->setTag($tagName, $tagValue); 
\&             $storage->setTag($tagName, \e@tagValues); 
\& Function  : Adds the tag name/value pair to this result
\& Arguments : String - name of the property to set
\&             Scalar - value of the property 
\& Example   : See Usage
\& Returns   : Scalar - the new tag value
.Ve
.Sh "getAllTagNames"
.IX Subsection "getAllTagNames"
.Vb 5
\& Usage     : @tagNames = $tagHolder->getAllTagNames(); 
\& Function  : Get an array of all the tag names 
\& Arguments : <n/a>
\& Example   : See Usage
\& Returns   : Array of String - all the tag names for this storage
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Clinton Torres (clinton.torres@llnl.gov)
.SH "SEE ALSO"
.IX Header "SEE ALSO"