AAO DRAMA/DRAMA2 C++ Interface
DRAMA C++11 and later interface
Public Member Functions | Protected Member Functions | List of all members
drama::BulkDataArg Class Reference

Detailed Description

A class used to manage a bulk data argument to an action.

This class is used internally by DRAMA2 and can be used by actions to access SDS items in bulk data arguments.

A non-threaded action (or kick message) can create one of these to access bulk data.

#include "bulkdata.hh"

Inheritance diagram for drama::BulkDataArg:
drama::BulkData drama::BulkDataArgSds

Public Member Functions

 BulkDataArg ()
 Default constructor.
 
 BulkDataArg (BulkDataArg &&source) noexcept
 Move copy constructor.
 
 BulkDataArg (std::weak_ptr< Task > theTask)
 Constructor - creates a BulkDataArg item by calling DitsBulkArgInfo().
 
template<typename T >
T * Data (unsigned long *nitems=nullptr)
 Return a pointer to the actual data.
 
DitsSharedMemInfoTypeGetDitsSharedMemInfo ()
 Return a reference to the DitsSharedMemInfoType object managed by this.
 
unsigned long GetNotifyBytes () const
 Returns the notification size.
 
BulkDataArgoperator= (BulkDataArg &&rhs) noexcept
 Move assignment operator.
 
void Report (unsigned bytes)
 Notify DRAMA of the number of bulk data bytes used/processed.
 

Protected Member Functions

voidRawDataAddr () const
 Returns the raw address of the data.
 
unsigned long SizeBytes () const
 Return the size of the data in bytes.
 

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