PCL
pcl::AbstractImage::ThreadData Struct Reference

Thread synchronization data for status monitoring of parallel image processing tasks. More...

#include <AbstractImage.h>

Public Member Functions

 ThreadData ()=default
 
 ThreadData (const AbstractImage &image, size_type N)
 
 ThreadData (const StatusMonitor &a_status, size_type N)
 

Public Attributes

size_type count = 0
 current monitoring count.
 
Mutex mutex
 Mutual exclusion for synchronized thread access.
 
size_type numThreads = 0
 Number of concurrent threads being executed (set by RunThreads()).
 
StatusMonitor status
 Status monitoring object.
 
size_type total = 0
 Total monitoring count.
 

Detailed Description

The ThreadData structure provides the required objects to synchronize the status monitoring task for a set of running threads. An instance of ThreadData (or of a derived class) can be used along with the AbstractImage::RunThreads() function to run a set of threads with synchronized monitoring and task abortion.

Definition at line 964 of file AbstractImage.h.

Constructor & Destructor Documentation

◆ ThreadData() [1/3]

pcl::AbstractImage::ThreadData::ThreadData ( )
default

Constructs a default ThreadData object.

◆ ThreadData() [2/3]

pcl::AbstractImage::ThreadData::ThreadData ( const AbstractImage image,
size_type  N 
)
inline

Constructs a ThreadData object with a copy of the current status monitor of the specified image, and the specified total monitoring count N.

If a zero count N is specified, the monitor will be initialized as an unbounded monitor. See the StatusMonitor::Initialize() member function for more information.

Definition at line 986 of file AbstractImage.h.

◆ ThreadData() [3/3]

pcl::AbstractImage::ThreadData::ThreadData ( const StatusMonitor a_status,
size_type  N 
)
inline

Constructs a ThreadData object with a copy of the specified status monitor, and the specified total monitoring count N.

If a zero count N is specified, the monitor will be initialized as an unbounded monitor. See the StatusMonitor::Initialize() member function for more information.

Definition at line 1000 of file AbstractImage.h.


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