.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .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. \*(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- .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" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Biblio::SICI::ControlSegment 3pm" .TH Biblio::SICI::ControlSegment 3pm "2023-02-06" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Biblio::SICI::ControlSegment \- The control segment of a SICI .SH "VERSION" .IX Header "VERSION" version 0.04 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& my $sici = Biblio::SICI\->new(); \& \& $sici\->control\->csi(2); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fIPlease note:\fR You are expected to not directly instantiate objects of this class! .PP The control segment of a \s-1SICI\s0 describes various aspects of the \fIthing\fR referenced by the \s-1SICI\s0 using pre-defined codes. The segment also contains some meta-information about the \s-1SICI\s0 itself. .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" For each attribute, clearer (\*(L"clear_\*(R") and predicate (\*(L"has_\*(R") methods are provided. .ie n .IP """dpi""" 4 .el .IP "\f(CWdpi\fR" 4 .IX Item "dpi" The \fIDerivative Part Identifier\fR tells us, what kind of \fIthing\fR is described by the \s-1SICI.\s0 It can take one of four different values: .Sp \&\fB0\fR => \s-1SICI\s0 describes Serial Item or Contribution itself \&\fB1\fR => \s-1SICI\s0 describes ToC of Serial Item or Contribution \&\fB2\fR => \s-1SICI\s0 describes Index of Serial Item or Contribution \&\fB3\fR => \s-1SICI\s0 describes Abstract of Serial Item or Contribution .Sp The default value is \fB0\fR. .ie n .IP """mfi""" 4 .el .IP "\f(CWmfi\fR" 4 .IX Item "mfi" The \fIMedium / Format Identifier\fR can take one of these codes: .Sp \&\fB\s-1CD\s0\fR => Computer-readable optical media (CD-ROM) \&\fB\s-1CF\s0\fR => Computer-readable magnetic disk media \&\fB\s-1CO\s0\fR => Online (remote) \&\fB\s-1CT\s0\fR => Computer-readable magnetic tape media \&\fB\s-1HD\s0\fR => Microfilm \&\fB\s-1HE\s0\fR => Microfiche \&\fB\s-1SC\s0\fR => Sound recording \&\fB\s-1TB\s0\fR => Braille \&\fB\s-1TH\s0\fR => Printed text, hardbound \&\fB\s-1TL\s0\fR => Printed text, looseleaf \&\fB\s-1TS\s0\fR => Printed text, softcover \&\fB\s-1TX\s0\fR => Printed text \&\fB\s-1VX\s0\fR => Video recording \&\fB\s-1ZN\s0\fR => Multiple physical forms \&\fB\s-1ZU\s0\fR => Physical form unknown \&\fB\s-1ZZ\s0\fR => Other physical form .Sp The default value is \fB\s-1ZU\s0\fR. .ie n .IP """version""" 4 .el .IP "\f(CWversion\fR" 4 .IX Item "version" The number of the standards version to which the \s-1SICI\s0 should adhere. The default is \fB2\fR (which means Z39.56\-1996), since that is also the only currently supported version. .SH "METHODS" .IX Header "METHODS" .ie n .IP """csi""" 4 .el .IP "\f(CWcsi\fR" 4 .IX Item "csi" The \fICode Structure Identifier\fR tells something about which parts of the \&\s-1SICI\s0 carry values. It can take one of three values: .Sp \&\fB1\fR => \s-1SICI\s0 for Serial Item \&\fB2\fR => \s-1SICI\s0 for Serial Contribution \&\fB3\fR => \s-1SICI\s0 for Serial Contribution \*(L"with obscure numbering\*(R" .Sp This method automatically derives the correct value from the presence of the respective data elements in the item and contribution segments. If no data is present in the contribution segment the final default is \fB1\fR. .ie n .IP "\s-1STRING\s0 ""to_string""()" 4 .el .IP "\s-1STRING\s0 \f(CWto_string\fR()" 4 .IX Item "STRING to_string()" Returns a stringified representation of the data in the control segment. .Sp Please note that the check digit is \fInot\fR considered to be a part of the control segment (but the \*(L"\-\*(R" preceding it in the \s-1SICI\s0 string is). .ie n .IP """reset""()" 4 .el .IP "\f(CWreset\fR()" 4 .IX Item "reset()" Resets all attributes to their default values. .ie n .IP "\s-1BOOL\s0 ""is_valid""()" 4 .el .IP "\s-1BOOL\s0 \f(CWis_valid\fR()" 4 .IX Item "BOOL is_valid()" Checks if the data for the control segment conforms to the standard. .SH "SEE ALSO" .IX Header "SEE ALSO" Biblio::SICI::Role::ValidSegment .SH "AUTHOR" .IX Header "AUTHOR" Heiko Jansen .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2014 by Heiko Jansen. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.