oaMemoryError Class Reference

Inheritance diagram for oaMemoryError:

oaException


Public Methods

oaUInt8 getAllocSize () const
oaUInt8 getSbrk () const
oaUInt8 getOAVMSize () const
oaUInt8 getAvailableMem () const
oaUInt8 getPhysicalMem () const
oaUInt8 getLimitMem () const
oaBoolean isUnlimited () const

Friends

class oaMemoryErrorFactory

Detailed Description

The oaMemoryError class represents an exception that OpenAccess throws when oaMemory::get() or oaMemory::resize() is called for a process and it detects that the process is out of memory.

The class includes functions that can be used to access system and process memory information related to the out-of-memory exception.


Member Function Documentation

oaUInt8 oaMemoryError::getAllocSize   const
 

This function returns the size of memory that OpenAccess tried to allocate.

oaUInt8 oaMemoryError::getAvailableMem   const
 

This function returns the size of available system memory.

oaUInt8 oaMemoryError::getLimitMem   const
 

This function returns the size of the memory limit, if set.

oaUInt8 oaMemoryError::getOAVMSize   const
 

This function returns the total number of bytes OpenAccess is currently using in virtual memory including all allocations it has made.

oaUInt8 oaMemoryError::getPhysicalMem   const
 

This function returns the size of system physical memory.

oaUInt8 oaMemoryError::getSbrk   const
 

This function returns the size of virtual memory on the heap.

oaBoolean oaMemoryError::isUnlimited   const
 

This function returns true if the memory limit is set; otherwise it returns false.


Friends And Related Function Documentation

friend class oaMemoryErrorFactory [friend]
 


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

Return to top of page