/ 
eSTAR-RTML-1.7.0
/ eSTAR::RTML::Parse

NAME

eSTAR::RTML::Parse - module which parses valid RTML messages

SYNOPSIS

  $message = new eSTAR::RTML::Parse( RTML => $rtml );

DESCRIPTION

The module parses incoming RTML messages recieved by the intelligent gent from the discovery node, it takes an eSTAR::RTML object as input returning an object with parsed RTML. The object has various query methods enabled allowing the user to grab tag values simply.

REVISION

$Id: Parse.pm,v 1.17 2003/07/15 08:16:51 aa Exp $

METHODS

Constructor

new

Create a new instance from a hash of options

$message = new eSTAR::RTML::Parse( RTML => $rtml );

returns a reference to an message object.

Accessor Methods

dtd

Return the DTD version of the RTML document

$version = $rtml->dtd();
type

Return the type of the RTML document

$type = $rtml->type();
score

Return the Score tag from the RTML document

$score = $rtml->score();
time

Return the CompletionTime from of the RTML document

$completion_time = $rtml->time();
fitsheaders

Return the FITS headers from the RTML as an array reference

$hdu = $rtml->fitsheaders();
catalogue

Return the Cluster format catalogue as an array reference

$catalog = $rtml->catalogue();
dataimage

Return the URL of the data image

$url = $rtml->dataimage();
id

Return the unqiue ID of the observation

$unique_id = $rtml->id();
name

Return the real name of the observer

$real_name = $rtml->name();
user

Return the user name of the observer

$user = $rtml->user();
institution

Return the institution that the observer has claimed affiliation to,

$inst = $rtml->institution();
email

Return the email address of the observer

$email = $rtml->email();
target

Return the name of the target

$target_name = $rtml->target();
ra

Return the R.A. of the target

$ra = $rtml->ra();
dec

Return the Dec. of the target

$dec = $rtml->dec();
exposure

Return the exposure time required

$exposure_time = $rtml->exposure();
snr

Return the signal-to-noise ratio required

$snr = $rtml->snr();
flux

Return the Flux defining the signal-to-noise ratio required

$flux = $rtml->flux();
equinox

Return the equinox of the RA and Dec

$equinox = $rtml->equinox();
host

Return the host of the IA origininating the document

$host = $rtml->host();
port

Return the port of the IA origininating the document

$host = $rtml->port();

General Methods

configure

Configures the object, takes an options hash as an argument

$message->configure( %options );

Does nothing if the hash is not supplied. This is called directly from the constructor during object creation

rtml

Populate the pre-parsed RTML document tree using an eSTAR::RTML object

$message->rtml( $rtml_object );

and parse the tree. This method is called directly from the configure method if an RTML key and value is supplied to the %options hash.

freeze

Method to return a blessed reference to the object so that we can store ths object on disk using Data::Dumper module.

COPYRIGHT

Copyright (C) 2002 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>,