MAK RTIspy API Documentation for HLA 1.3
List of all members | Public Member Functions | Protected Attributes | Private Member Functions
DtSharedMemoryPoolManager__rti__ Class Reference

This class creates and manages a shared memory pool. More...

+ Collaboration diagram for DtSharedMemoryPoolManager__rti__:

Public Member Functions

 DtSharedMemoryPoolManager__rti__ (const MAKRti::DtString &shared_name, unsigned long size, DtShmPoolCreationMode create=DtShmPoolCreationMode_Normal)
 creates a shared memory pool with name shared_name, of the specified size.
virtual ~DtSharedMemoryPoolManager__rti__ ()
 Closes the memory pool.
void * address () const
 returns the address of the successfully created memory pool.

Protected Attributes

MAKRti::DtString myName
void * myAddr
int myId

Private Member Functions

 DtSharedMemoryPoolManager__rti__ (const DtSharedMemoryPoolManager__rti__ &other)
 Copy Ctor not implemented.
DtSharedMemoryPoolManager__rti__operator= (const DtSharedMemoryPoolManager__rti__ &other)
 Assignment Operator not implemented.

Detailed Description

This class creates and manages a shared memory pool.

It will create a pool on construction and delete the pool when it is destroyed. There is currently no way to preserve the pool past the life of this class.

Constructor & Destructor Documentation

DtSharedMemoryPoolManager__rti__::DtSharedMemoryPoolManager__rti__ ( const MAKRti::DtString &  shared_name,
unsigned long  size,
DtShmPoolCreationMode  create = DtShmPoolCreationMode_Normal 
)

creates a shared memory pool with name shared_name, of the specified size.

If the pool already exists this manager will join the pool and not throw an error. If an error occurs the CTOR will throw a MAKRti::DtException with a useful description of the error.

DtSharedMemoryPoolManager__rti__::~DtSharedMemoryPoolManager__rti__ ( )
virtual

Closes the memory pool.

References myAddr, myId, myName, and NULL.

DtSharedMemoryPoolManager__rti__::DtSharedMemoryPoolManager__rti__ ( const DtSharedMemoryPoolManager__rti__ other)
private

Copy Ctor not implemented.

Member Function Documentation

void * DtSharedMemoryPoolManager__rti__::address ( ) const

returns the address of the successfully created memory pool.

References myAddr.

DtSharedMemoryPoolManager__rti__& DtSharedMemoryPoolManager__rti__::operator= ( const DtSharedMemoryPoolManager__rti__ other)
private

Assignment Operator not implemented.

Member Data Documentation

void* DtSharedMemoryPoolManager__rti__::myAddr
protected
int DtSharedMemoryPoolManager__rti__::myId
protected
MAKRti::DtString DtSharedMemoryPoolManager__rti__::myName
protected

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

Document ID: Generated on Fri Mar 14 19:08:55 EDT 2014 from SVN revision 137085
Copyright © 2005-2014 VT MÄK Inc. All Rights Reserved (www.mak.com)