NAME

       sc::ProcThreadGrp - The ProcThreadGrp class privides a concrete thread group appropriate
       for an environment where there is only one thread.

SYNOPSIS

       #include <thread.h>

       Inherits sc::ThreadGrp.

   Public Member Functions
       ProcThreadGrp (const Ref< KeyVal > &)
       int start_threads ()
           Starts the threads running.
       int wait_threads ()
           Wait for all the threads to complete.
       Ref< ThreadLock > new_lock ()
           Return a local object.
       ThreadGrp * clone (int nthread=-1)
           Create a ThreadGrp like the current one.

       Public Member Functions inherited from sc::ThreadGrp
       ThreadGrp (const Ref< KeyVal > &)
       ThreadGrp (const ThreadGrp &, int nthread=-1)
       virtual void add_thread (int threadnum, Thread *thread)
           Assigns a Thread object to each thread.
       virtual void add_thread (int threadnum, Thread *thread, int priority)
           Like add_thread(threadnum, thread), but assign a priority that the thread is to use.
       int nthread () const
           The number of threads that will be run by start_thread.
       void delete_threads ()

       Public Member Functions inherited from sc::DescribedClass
       DescribedClass (const DescribedClass &)
       DescribedClass & operator= (const DescribedClass &)
       ClassDesc * class_desc () const  throw ()
           This returns the unique pointer to the ClassDesc corresponding to the given type_info
           object.
       const char * class_name () const
           Return the name of the object's exact type.
       int class_version () const
           Return the version of the class.
       virtual void print (std::ostream &=ExEnv::out0()) const
           Print the object.

       Public Member Functions inherited from sc::RefCount
       int lock_ptr () const
           Lock this object.
       int unlock_ptr () const
           Unlock this object.
       void use_locks (bool inVal)
           start and stop using locks on this object
       refcount_t nreference () const
           Return the reference count.
       refcount_t reference ()
           Increment the reference count and return the new count.
       refcount_t dereference ()
           Decrement the reference count and return the new count.
       int managed () const
       void unmanage ()
           Turn off the reference counting mechanism for this object.
       int managed () const
           Return 1 if the object is managed. Otherwise return 0.

       Public Member Functions inherited from sc::Identity
       Identifier identifier ()
           Return the Identifier for this argument.

   Additional Inherited Members
       Static Public Member Functions inherited from sc::ThreadGrp
       static void set_default_threadgrp (const Ref< ThreadGrp > &)
       static ThreadGrp * get_default_threadgrp ()
       static ThreadGrp * initial_threadgrp (int &argc, char **argv)

       Protected Member Functions inherited from sc::RefCount
       RefCount (const RefCount &)
       RefCount & operator= (const RefCount &)

       Protected Attributes inherited from sc::ThreadGrp
       Thread ** threads_
       int nthread_

Detailed Description

       The ProcThreadGrp class privides a concrete thread group appropriate for an environment
       where there is only one thread.

Member Function Documentation

   ThreadGrp * sc::ProcThreadGrp::clone (int nthread = -1) [virtual]
       Create a ThreadGrp like the current one. If nthread is given, the new ThreadGrp will
       attempt to support that number of threads, but the actual number supported may be less. If
       nthread is -1, the number of threads in the current group will be used.

       Reimplemented from sc::ThreadGrp.

   Ref< ThreadLock > sc::ProcThreadGrp::new_lock () [virtual]
       Return a local object.

       Implements sc::ThreadGrp.

   int sc::ProcThreadGrp::start_threads () [virtual]
       Starts the threads running. Thread 0 will be run by the thread that calls start_threads.

       Implements sc::ThreadGrp.

   int sc::ProcThreadGrp::wait_threads () [virtual]
       Wait for all the threads to complete. This must be called before start_threads is called
       again or the object is destroyed.

       Implements sc::ThreadGrp.

Author

       Generated automatically by Doxygen for MPQC from the source code.