[OPUS]

Proc_stat - A field object that stores the STATUS portion of a PSTAT.


Availability:

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

Constructors:
Proc_stat( )
~Proc_stat( )

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

Data Members:


 static const std::string IDLE;        // process is idle

 static const std::string PROCESSING;  // process is processing

 static const std::string ABSENT;      // process is absent

 static const std::string IOWAIT;      // process is in IO wait state

 static const std::string SUSPENDED;   // process is suspended

 static const std::string HALTED;      // process is halted

 static const std::string RESUMED;     // process is resuming

 static const std::string REINITED;    // process is reinitializing

Description

Proc_stat objects contain a string indicating the status of the process that is attached to that PSTAT. The following status strings are pre-defined:

Proc_stat::IDLE Proc_stat::PROCESSING Proc_stat::ABSENT Proc_stat::IOWAIT Proc_stat::SUSPENDED Proc_stat::HALTED Proc_stat::RESUMED Proc_stat::REINITED

Derived from

Field

See Also:


Proc_stat::Proc_stat - The Proc_stat constructor.

Synopsis


Proc_stat::Proc_stat(
                     const string& s)  // I - status string

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

Description

The constructor creates a new Proc_stat object, initialized with the calling argument (if provided).

Exceptions Thrown

none

Example

  
    #include "opus_env.h"
    #include "proc_stat.h"
  
    // The following example sets the process' PSTAT to "WAITING".
    int main(int argc, char* argv[])
    {
       Opus_env oenv(argc, argv);
  
       Proc_stat* ps = new Proc_stat("WAITING");
       oenv.update_proc_stat(ps);
       delete ps;
    }
  


Proc_stat::~Proc_stat - The Proc_stat destructor.

Synopsis


Proc_stat::~Proc_stat() 

Description

This method destroys the object.

Exceptions Thrown

none


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

Synopsis


Field* Proc_stat::clone() const

Description

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

Returns

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

Exceptions Thrown

none


Proce_stat::name - Get the field name

Synopsis


string Proc_stat::name() const 

Description

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

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