1.2. accessPacket

Full Name: herschel.hifi.dp.access.AccessPacketTask
Alias: accessPacket
Type: Java Task - Java Task
Import: from herschel.hifi.dp.access import AccessPacketTask
Category

HIFI/Pipeline/ICC

Description

AccessPacketTask

This task is a wrapper around the HCSS tasks used to retrieve telemetry packets from files. This task is specifically designed to support data access for the HIFI pipeline.

Example

Example 1: AccessPacketTask
from herschel.hifi.dp.access import AccessPacketTask
# usage on command line:
pk = AccessPacketTask()(apids=[1030,1026], obsid=1342177771)
# Access packets using GUI:
hktask = AccessPacketTask()
hktask.obsid=1342177771
hktask.gui=1
# use gui to setup parameters and select "execute"
pk = hktask.result
# POSSIBLY use gui again for select selection, select "execute"
pk2 = hktask.result
# print the number of packets
print len(pk)

Limitations

The amount of data that can be loaded is limited to size of ones java heap space

API details

Properties

Long bbtype [INPUT, OPTIONAL, default=null]

Provides the Building block id.

Long obsid [INPUT, OPTIONAL, default=null]

Provides the Observation id.

Integer apid [INPUT, OPTIONAL, default=null]

Provides the apid.

Integer[] apids [INPUT, OPTIONAL, default=null]

Provides an array of apids.

Integer type [INPUT, OPTIONAL, default=null]

Provides the type.

Integer[] types [INPUT, OPTIONAL, default=null]

Provides an array of types.

Integer subtype [INPUT, OPTIONAL, default=null]

Provides the subtype.

Integer[] subtypes [INPUT, OPTIONAL, default=null]

Provides an array of subtypes.

Integer sid [INPUT, OPTIONAL, default=null]

Provides the sid.

Integer[] sids [INPUT, OPTIONAL, default=null]

Provides an array of sids.

String param [INPUT, OPTIONAL, default=null]

Provides a single parameter id.

String[] params [INPUT, OPTIONAL, default=null]

Provides an array of parameter ids.

String packettype [INPUT, OPTIONAL, default=null]

Provides a single packettype.

String[] packettypes [INPUT, OPTIONAL, default=null]

Provides an array of packettypes.

Boolean p2q [INPUT, OPTIONAL, default=false]

p2q = Boolean.TRUE will translate the parameters into a specific query only returning those packets which contain the requested parameter. This is used when searching large numbers of packets were the amount of computer memory is an issue. It has been shown that setting this can slow down database access for remote users.

FineTime start [INPUT, OPTIONAL, default=null]

Provides the start time.

FineTime end [INPUT, OPTIONAL, default=null]

Provides the end time.

Boolean exit [INPUT, OPTIONAL, default=false]

Provides a handle to exit gui.

Boolean gui [INPUT, OPTIONAL, default=false]

Allows to handle task using a gui.

TmSourcePacket[] result [OUTPUT, OPTIONAL, default=null]

Returns an array of packets collected from the database.

See also

History

  • 2005-02-21 - jcg: change doc format for help support.
  • 2006-02-02 - pz: implemented HifiTask adding a dialog and gui
  • 2006-04-11 - ke: throw runtime exception if gui is used with jide
  • 2006-04-27 - ke: added tabbed DATA, TIME and DATABASE selector panel
  • 2006-06-07 - PAZ: updated to new Task.views parameter by Peer, i.e. removing HifiTask specifics
  • 2006-07-10 - ke: allowed some task parameters to contain null values
  • 2006-07-24 - ke: integrated MibSupport into task
  • 2006-10-23 - ke: added times to all queries with an obsid (speed up remote access to dbs)
  • 2007-01-10 - PAZ: do a close in case after one has retrieved data from a database
  • 2007-01-25 - DK: add a streaming option and output
  • 2007-02-16 - ke: reusing the store from Access and moved the code that adds times to the db queries
  • 2007-03-29 - ke: adding new parameters for export for the non-gui part of this application.
  • 2007-03-30 - ke: refactoring the execute method and created a new method call setUpLocalConnection
  • 2008-03-13 - ke: Changes to the gui behaviour and to the store parameter
  • 2015-02-23 - ke: Removed all calls/references to versant related packages, only TM file access supported.