graph::easy::layout::chain(3pm) [debian man page]
Graph::Easy::Layout::Chain(3pm) User Contributed Perl Documentation Graph::Easy::Layout::Chain(3pm) NAME
Graph::Easy::Layout::Chain - Chain of nodes for layouter SYNOPSIS
# used internally, do not use directly use Graph::Easy; use Graph::Easy::Layout::Chain; my $graph = Graph::Easy->new( ); my ($node, $node2) = $graph->add_edge( 'A', 'B' ); my $chain = Graph::Easy::Layout::Chain->new( start => $node, graph => $graph, ); $chain->add_node( $node2 ); DESCRIPTION
A "Graph::Easy::Layout::Chain" object represents a chain of nodes for the layouter. METHODS
new() my $chain = Graph::Easy::Layout::Chain->new( start => $node ); Create a new chain and set its starting node to $node. length() my $len = $chain->length(); Return the length of the chain, in nodes. my $len = $chain->length( $node ); Given an optional $node as argument, returns the length from that node onwards. For the chain with the three nodes A, B and C would return 3, 2, and 1 for A, B and C, respectively. Returns 0 if the passed node is not part of this chain. nodes() my @nodes = $chain->nodes(); Return all the node objects in the chain as list, in order. add_node() $chain->add_node( $node ); Add $node to the end of the chain. start() my $node = $chain->start(); Return first node in the chain. end() my $node = $chain->end(); Return last node in the chain. layout() my $todo = $chain->layout(); Return an action stack as array ref, containing the nec. actions to layout the chain (nodes, plus interlinks in the chain). Will recursively traverse all chains linked to this chain. merge() my $chain->merge ( $other_chain ); my $chain->merge ( $other_chain, $where ); Merge the other chain into ourselves, adding its nodes at our end. The other chain is emptied and must be deleted by the caller. If $where is defined and a member of $other_chain, absorb only the nodes from $where onwards, instead of all of them. error() $last_error = $node->error(); $node->error($error); # set new messags $node->error(''); # clear error Returns the last error message, or '' for no error. dump() $chain->dump(); Dump the chain to STDERR, to aid debugging. EXPORT
None by default. SEE ALSO
Graph::Easy, Graph::Easy::Layout. AUTHOR
Copyright (C) 2004 - 2006 by Tels <http://bloodgate.com>. See the LICENSE file for more details. perl v5.14.2 2011-12-23 Graph::Easy::Layout::Chain(3pm)
Check Out this Related Man Page
Graph::Easy::Base(3pm) User Contributed Perl Documentation Graph::Easy::Base(3pm) NAME
Graph::Easy::Base - base class for Graph::Easy objects like nodes, edges etc SYNOPSIS
package Graph::Easy::My::Node; use Graph::Easy::Base; @ISA = qw/Graph::Easy::Base/; DESCRIPTION
Used automatically and internally by Graph::Easy - should not be used directly. METHODS
new() my $object = Graph::Easy::Base->new(); Create a new object, and call "_init()" on it. error() $last_error = $object->error(); $object->error($error); # set new messags $object->error(''); # clear the error Returns the last error message, or '' for no error. When setting a new error message, "$self->_croak($error)" will be called unless "$object->no_fatal_errors()" is true. error_as_html() my $error = $object->error_as_html(); Returns the same error message as error(), but properly escaped as HTML so it is safe to output to the client. warn() $object->warn('Warning!'); Warn on STDERR with the given message. no_fatal_errors() $object->no_fatal_errors(1); Set the flag that determines whether setting an error message via "error()" is fatal, e.g. results in a call to "_croak()". A true value will make errors non-fatal. See also fatal_errors. fatal_errors() $fatal = $object->fatal_errors(); $object->fatal_errors(0); # turn off $object->fatal_errors(1); # turn on Set/get the flag that determines whether setting an error message via "error()" is fatal, e.g. results in a call to "_croak()". A true value makes errors fatal. catch_errors() my $catch_errors = $object->catch_errors(); # query $object->catch_errors(1); # enable $object->...(); # some error if ($object->error()) { my @errors = $object->errors(); # retrieve } Enable/disable catching of all error messages. When enabled, all previously caught error messages are thrown away, and from this poin on new errors are non-fatal and stored internally. You can retrieve these errors later with the errors() method. catch_warnings() my $catch_warns = $object->catch_warnings(); # query $object->catch_warnings(1); # enable $object->...(); # some error if ($object->warning()) { my @warnings = $object->warnings(); # retrieve } Enable/disable catching of all warnings. When enabled, all previously caught warning messages are thrown away, and from this poin on new warnings are stored internally. You can retrieve these errors later with the errors() method. catch_messages() # catch errors and warnings $object->catch_messages(1); # stop catching errors and warnings $object->catch_messages(0); A true parameter is equivalent to: $object->catch_warnings(1); $object->catch_errors(1); See also: catch_warnings() and catch_errors() as well as errors() and warnings(). errors() my @errors = $object->errors(); Return all error messages that occured after catch_messages() was called. warnings() my @warnings = $object->warnings(); Return all warning messages that occured after catch_messages() or catch_errors() was called. self() my $self = $object->self(); Returns the object itself. class() my $class = $object->class(); Returns the full class name like "node.cities". See also "sub_class". sub_class() my $sub_class = $object->sub_class(); Returns the sub class name like "cities". See also "class". main_class() my $main_class = $object->main_class(); Returns the main class name like "node". See also "sub_class". EXPORT
None by default. SEE ALSO
Graph::Easy. AUTHOR
Copyright (C) 2004 - 2008 by Tels <http://bloodgate.com>. See the LICENSE file for more details. perl v5.14.2 2011-12-23 Graph::Easy::Base(3pm)