Astro::SIMBAD::Result::Object - A individual astronomical object

  $object = new Astro::SIMBAD::Result::Object( Name   => $object_name,
                                               Type   => $object_type,
                                               Long   => $long_type,
                                               Frame => \@coord_frame,
                                               RA     => $ra,
                                               Dec    => $declination,
                                               Spec   => $spectral_type,
                                               URL    => $url );

package Astro::SIMBAD::Result::Object;

# ---------------------------------------------------------------------------

#+
#  Name:
#    Astro::SIMBAD::Result:Object

#  Purposes:
#    Perl wrapper for the SIMBAD database

#  Language:
#    Perl module

#  Description:
#    This module wraps the SIMBAD online database.

#  Authors:
#    Alasdair Allan (aa@astro.ex.ac.uk)

#  Revision:
#     $Id: Object.pm,v 1.3 2005/06/08 01:38:17 aa Exp $

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

#-

# ---------------------------------------------------------------------------

# L O A D   M O D U L E S --------------------------------------------------

use strict;
use vars qw/ $VERSION /;

'$Revision: 1.3 $ ' =~ /.*:\s(.*)\s\$/ && ($VERSION = $1);

# C O N S T R U C T O R ----------------------------------------------------

sub new {
  my $proto = shift;
  my $class = ref($proto) || $proto;

  # bless the query hash into the class
  my $block = bless { NAME    => undef,
		      TARGET  => undef,
                      TYPE    => undef,
                      LONG    => undef,
                      FRAME   => [],
                      RA      => undef,
                      DEC     => undef,
                      SPEC    => undef,
                      URL     => undef,
		      BMAG    => undef,
		      VMAG    => undef,
		      IDENT   => [],
		      PM      => [],
		      PLX     => undef,
		      RADIAL  => undef,
		      REDSHIFT=> undef,
		  }, $class;

  # If we have arguments configure the object
  $block->configure( @_ ) if @_;

  return $block;

}

# A C C E S S O R  --------------------------------------------------------

sub name {
  my $self = shift;
  if (@_) {
    $self->{NAME} = shift;
  }
  return $self->{NAME};
}

sub target {
  my $self = shift;
  if (@_) {
    $self->{TARGET} = shift;
  }
  return $self->{TARGET};
}

sub type {
  my $self = shift;
  if (@_) {
    $self->{TYPE} = shift;
  }
  return $self->{TYPE};
}

sub long {
  my $self = shift;
  if (@_) {
    $self->{LONG} = shift;
  }
  return $self->{LONG};
}

sub frame {
  my $self = shift;

  if (@_) {
    # take a local copy to avoid "copy of copy" problems
    my $frame = shift;
    @{$self->{FRAME}} = @{$frame};
  }
   
  my $stringify = 
     "${$self->{FRAME}}[0] ${$self->{FRAME}}[1]/${$self->{FRAME}}[2]";
     
  return wantarray ? @{$self->{FRAME}} : $stringify;
}

sub ra {
  my $self = shift;
  if (@_) {
    $self->{RA} = shift;
  }
  return $self->{RA};
}

sub dec {
  my $self = shift;
  if (@_) {
    $self->{DEC} = shift;
  }
  return $self->{DEC};
}

sub spec {
  my $self = shift;
  if (@_) {
    $self->{SPEC} = shift;
  }
  return $self->{SPEC};
}

sub url {
  my $self = shift;
  if (@_) {
    $self->{URL} = shift;
  }
  return $self->{URL};
}

sub bmag {
  my $self = shift;
  if (@_) {
    $self->{BMAG} = shift;
  }
  return $self->{BMAG};
}

sub vmag {
  my $self = shift;
  if (@_) {
    $self->{VMAG} = shift;
  }
  return $self->{VMAG};
}

sub ident {
  my $self = shift;
  if (@_) {
    my $idarray = shift;
    @{$self->{IDENT}} = @{$idarray};
  }
  return $self->{IDENT};
}

sub pm {
  my $self = shift;
  if (@_) {
    push @{$self->{PM}}, @_[0..1];
  }
  return $self->{PM};
}

sub plx {
  my $self = shift;
  if (@_) {
    $self->{PLX} = shift;
  }
  return $self->{PLX};
}

sub radial {
  my $self = shift;
  if (@_) {
    $self->{RADIAL} = shift;
  }
  return $self->{RADIAL};
}

sub redshift {
  my $self = shift;
  if (@_) {
    $self->{REDSHIFT} = shift;
  }
  return $self->{REDSHIFT};
}

# C O N F I G U R E -------------------------------------------------------

sub configure {
  my $self = shift;

  # return unless we have arguments
  return undef unless @_;

  # grab the argument list
  my %args = @_;

  # Loop over the allowed keys storing the values
  # in the object if they exist
  for my $key (qw / Name Type Long Frame RA Dec Spec URL /) {
      my $method = lc($key);
      $self->$method( $args{$key} ) if exists $args{$key};
  }

}


# T I M E   A T   T H E   B A R  --------------------------------------------

# L A S T  O R D E R S ------------------------------------------------------

1;