Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Result(3)	      User Contributed Perl Documentation	     Result(3)

NAME
       Astro::SIMBAD::Result - Results from an SIMBAD Query

SYNOPSIS
	 $result = new Astro::SIMBAD::Result( Objects => \@objects );

DESCRIPTION
       Stores the results returned from	an SIMBAD search as a hash of
       Astro::SIMBAD::Result::Object objects with the objects being indexed by
       Object Name.

REVISION
       $Id: Result.pm,v	1.3 2001/11/28 17:43:34	aa Exp $

METHODS
   Constructor
       new Create a new	instance from a	hash of	options

	     $result = new Astro::SIMBAD::Result( Objects => \@objects );

	   returns a reference to an SIMBAD Result object.

   Accessor Methods
       sizeof
	   Return the number of	objects	in the Astro::SIMBAD::Result object.

	      $num = $result->sizeof();

       addobject
	   Push	a new Astro::SIMBAD::Result::Object object onto	the end	of the
	   Astro::SIMBAD::Result object

	      $result->addobject( $object );

	   returns the number of objects now in	the Result object.

       objects
	   Return an array of all the "Astro::SIMBAD::Result::Object" objects
	   stored in the results object.

	     @objects =	$result->objects;

       objectbyname
	   Returns an list of "Astro::SIMBAD::Result::Object" objects by name

	     @objects =	$result->objectbyname("IP Peg");

	   the name given does not have	to be a	full object name, only a sub-
	   string.  However, if	multiple matches are found an array of
	   possible matches will be returned.

       listofobjects
	   Returns a list of all the stellar objects held in the Result	object

	       @object_name = $result->listofobjects();
	       $number = $result->listofobjects();

	   if called in	a scalar context it will return	the number of objects
	   in the Result object.

   General Methods
       configure
	   Configures the object, takes	an options hash	as argument

	     $result->configure( %options );

	   Takes a hash	as argument with the following keywords:

COPYRIGHT
       Copyright (C) 2001 University of	Exeter.	All Rights Reserved.

       This program was	written	as part	of the eSTAR project and is free
       software; you can redistribute it and/or	modify it under	the terms of
       the GNU Public License.

AUTHORS
       Alasdair	Allan <aa@astro.ex.ac.uk>,

perl v5.24.1			  2001-11-28			     Result(3)

NAME | SYNOPSIS | DESCRIPTION | REVISION | METHODS | COPYRIGHT | AUTHORS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Astro::SIMBAD::Result&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help