[OPUS]

Time_stamp - A field object that stores the TIME_STAMP portion of an OSF.


Availability:

This class is available for the OPUS Blackboard API. The initial OPUS 2.0 release is described here

Constructors:
Time_stamp( )
~Time_stamp( )

Methods:
clone( ) create copy of object
name( ) get field name

Description

Time_stamp objects contain the processing start time for the dataset in seconds since the Epoch (00:00 Januray 1, 1970) encoded in hexadecimal.

Derived from

Opus_time_stamp

See Also:


Time_stamp::Time_stamp - The Time_stamp constructor.

Synopsis


Time_stamp::Time_stamp() : Opus_time_stamp(Bb_params_db::get_id("TIME_STAMP"),
                           Bb_params_db::get_size("TIME_STAMP"))

Time_stamp::Time_stamp(
                       const string& s) // I - time string

Time_stamp::Time_stamp(
                       const Time_stamp& di) // I - object to initialize from

Description

The constructor initializes the object with the calling argument (if provided). The default constructor places the current system time in hex format into the object. Arguments must contain a correctly formatted time stamp.

Exceptions Thrown

Bad_val<string> - if string contains invalid characters or wrong size; Bad_val.arg contains the calling argument


Time_stamp::~Time_stamp - The Time_stamp destructor.

Synopsis


Time_stamp::~Time_stamp()

Description

This method destroys the object.

Exceptions Thrown

none


Time_stamp::clone - Create a copy of this object.

Synopsis


Field* Time_stamp::clone() const

Description

This method creates a new Time_stamp object, initialized by this object, off the heap and returns a pointer to the object. The client should delete the returned object when it is no longer needed.

Returns

    A pointer to the new Time_stamp object initialized by this object.

Exceptions Thrown

none


Time_stamp::name - Get the field name

Synopsis


string Time_stamp::name() const 

Description

This method returns the name of the field, "TIME".

Returns

    string field name

Exceptions Thrown

none


OPUS API index · STScI Home Page · Search · Topics · Index

Copyright © 1997-2000 The Association of Universities for Research in Astronomy, Inc. All Rights Reserved.


For more information, contact opushelp@stsci.edu

Last modified: 25 April 2000