.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 "GO::Model::Root 3pm" .TH GO::Model::Root 3pm "2021-01-09" "perl v5.32.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" .Vb 1 \& GO::Model::Root \- base class for all GO::Model objects .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" base class for all GO::Model objects .SH "Constructors" .IX Header "Constructors" .SS "new" .IX Subsection "new" Constructor: Basically just calls _initialize(). Most subclasses should not need to override new, but instead should override _initialize(). .PP If _initialize() fails , the procedure will die .PP \&\s-1WARNING:\s0 This procedure will die if initialization is unsuccessful. Use an eval statement to catch such exceptions. .SS "obj_factory" .IX Subsection "obj_factory" .Vb 4 \& Usage \- $obj\->obj_factory\->create_new_term_object($h); \& Alias \- apph \& Returns \- L \& Args \- none .Ve .SS "sprint_self" .IX Subsection "sprint_self" Prints out a description of the object to a string. .SS "dump" .IX Subsection "dump" dumps the object (can be read back in with eval) .SS "namespace" .IX Subsection "namespace" .Vb 8 \& Usage \- print $term\->namespace(); # getting the type \& Usage \- $term\->namespace("molecular_function"); # setting the type \& Alias \- type \& Alias \- term_type \& Alias \- category \& Alias \- ontology \& Returns \- string representing type \& Args \- string represnting type [optional] .Ve .PP The \s-1OBO\s0 namespace for the GO::Model::Term or GO::Model::Relationship .SS "_cleanup" .IX Subsection "_cleanup" Called at object destruction time. Should be overridden to perform cleanup tasks.