MPQC  3.0.0-alpha
sc::ProcThreadGrp Class Reference

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

#include <util/group/thread.h>

Inheritance diagram for sc::ProcThreadGrp:
sc::ThreadGrp sc::DescribedClass sc::RefCount

Public Member Functions

 ProcThreadGrp (const Ref< KeyVal > &)
 
int start_threads ()
 Starts the threads running. More...
 
int wait_threads ()
 Wait for all the threads to complete. More...
 
Ref< ThreadLocknew_lock ()
 Return a local object.
 
ThreadGrpclone (int nthread=-1)
 Create a ThreadGrp like the current one. More...
 
- 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. More...
 
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. More...
 
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 &)
 
DescribedClassoperator= (const DescribedClass &)
 
ClassDescclass_desc () const MPQC__NOEXCEPT
 This returns the unique pointer to the ClassDesc corresponding to the given type_info object. More...
 
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.
 
Ref< DescribedClassref ()
 Return this object wrapped up in a Ref smart pointer. More...
 
- Public Member Functions inherited from sc::RefCount
size_t identifier () const
 Return the unique identifier for this object that can be compared for different objects of different types. More...
 
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. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from sc::ThreadGrp
static void set_default_threadgrp (const Ref< ThreadGrp > &)
 Sets the default ThreadGrp. More...
 
static ThreadGrpget_default_threadgrp ()
 Returns the default ThreadGrp. More...
 
static ThreadGrpinitial_threadgrp (int &argc, char **argv)
 Create a ThreadGrp. More...
 
- Protected Member Functions inherited from sc::RefCount
 RefCount (const RefCount &)
 
RefCountoperator= (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

◆ clone()

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.

◆ start_threads()

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.

◆ wait_threads()

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.


The documentation for this class was generated from the following file:

Generated at Sun Jan 26 2020 23:24:09 for MPQC 3.0.0-alpha using the documentation package Doxygen 1.8.16.