SST  9.0.0
StructuralSimulationToolkit
SST::SharedRegion Class Reference
Inheritance diagram for SST::SharedRegion:
SST::SharedRegionImpl

Public Member Functions

void shutdown ()
 
size_t getLocalShareID () const
 
size_t getSize () const
 
void publish ()
 Call to denote that you are done making any changes to this region.
 
bool isReady () const
 
void modifyRegion (size_t offset, size_t length, const void *data)
 Before the region has published, apply a modification. More...
 
template<typename T >
void modifyArray (size_t offset, const T &data)
 
void * getRawPtr ()
 
template<typename T >
getPtr () const
 

Protected Member Functions

 SharedRegion (SharedRegionManager *manager, size_t id, size_t size)
 

Member Function Documentation

size_t SST::SharedRegion::getLocalShareID ( ) const
inline
Returns
The ID of this instance. (Number in range 0->N)
template<typename T >
T SST::SharedRegion::getPtr ( ) const
inline
Returns
a const pointer to the shared memory region
void* SST::SharedRegion::getRawPtr ( )
inline
Returns
a void* pointer to the shared memory region This pointer is only valid to write to before a call to publish()
size_t SST::SharedRegion::getSize ( ) const
inline
Returns
The size of the shared memory region
bool SST::SharedRegion::isReady ( ) const
inline
Returns
True if the region is ready to use (all sharers have called publish()).
void SST::SharedRegion::modifyRegion ( size_t  offset,
size_t  length,
const void *  data 
)
inline

Before the region has published, apply a modification.

(Copy this data in)


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