ImageMemoryManager Class Reference

An interface class to access DMA memory related properties(Device specific interface layout only). More...

Inheritance diagram for ImageMemoryManager:

Public Member Functions
synchronized void	delete ()
PropertyI	getAllocatedDMAMemory_bytes ()
	An integer property (read-only) containing the size of the allocated DMA memory (in bytes).
PropertyI	getMode ()
	An enumerated integer property containing the mode the memory manager is currently operated in.
PropertyI	getPoolBlockCount ()
	An integer property (read-only) containing the number of individual blocks of DMA memory currently available when using the current pool block size and pool mode.
PropertyI	getPoolBlockSize_bytes ()
	An integer property defining the size (in bytes) to use for each block of DMA memory.
PropertyI	getPoolMode ()
	An enumerated integer property containing the mode the memory managers memory pool is currently operated in.
PropertyI	getUsedBlocks ()
	An integer property (read-only) containing the number of individual blocks of DMA memory currently used by the device.
PropertyI	getUsedDMAMemory_bytes ()
	An integer property (read-only) containing the size of the DMA memory (in bytes) currently used by the device.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
	ImageMemoryManager (Device pDev)
	Constructs a new mvIMPACT.acquire.ImageMemoryManager object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
void	finalize ()
	ImageMemoryManager (long cPtr, boolean cMemoryOwn)

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)
static long	swigRelease (ImageMemoryManager obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

An interface class to access DMA memory related properties(Device specific interface layout only).

This class can be used to configure the way the device works with DMA memory. This is an advanced feature and shall only be used if necessary or to fine tune an application to achieve optimal performance.

All frame grabbers belonging to the mvTITAN, mvGAMMA, mvSIGMA and mvDELTA series use a special, preallocated block of memory(DMA memory) as target for fast image transfer. The total size of this block has to be set during driver installation. The memory is claimed from the operating system during startup and is shared between all installed devices.

The memory size needed to achieve optimal performance depends on the image size to grab, the queue depth and the mode the memory manager is operated in. Valid values for this property are defined by the enumeration mvIMPACT.acquire.TMemoryManagerMode and can be selected by modifying the property mvIMPACT.acquire.ImageMemoryManager.getMode().

Note

This class is currently available for frame grabber devices only.

This class will only be available if mvIMPACT.acquire.Device.getInterfaceLayout() is set to mvIMPACT.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

ImageMemoryManager() [1/2]

ImageMemoryManager ( long cPtr, boolean cMemoryOwn )

protected

ImageMemoryManager() [2/2]

ImageMemoryManager

(

Device

pDev

)

Constructs a new mvIMPACT.acquire.ImageMemoryManager object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.

Member Function Documentation

delete()

synchronized void delete

(

)

Reimplemented from ComponentCollection.

finalize()

void finalize ( )

protected

Reimplemented from ComponentCollection.

getAllocatedDMAMemory_bytes()

PropertyI getAllocatedDMAMemory_bytes

(

)

An integer property (read-only) containing the size of the allocated DMA memory (in bytes).

getMode()

PropertyI getMode

(

)

An enumerated integer property containing the mode the memory manager is currently operated in.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TMemoryManagerMode.

getPoolBlockCount()

PropertyI getPoolBlockCount

(

)

An integer property (read-only) containing the number of individual blocks of DMA memory currently available when using the current pool block size and pool mode.

getPoolBlockSize_bytes()

PropertyI getPoolBlockSize_bytes

(

)

An integer property defining the size (in bytes) to use for each block of DMA memory.

getPoolMode()

PropertyI getPoolMode

(

)

An enumerated integer property containing the mode the memory managers memory pool is currently operated in.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TMemoryManagerPoolMode.

getUsedBlocks()

PropertyI getUsedBlocks

(

)

An integer property (read-only) containing the number of individual blocks of DMA memory currently used by the device.

getUsedDMAMemory_bytes()

PropertyI getUsedDMAMemory_bytes

(

)

An integer property (read-only) containing the size of the DMA memory (in bytes) currently used by the device.

hObj()

int hObj ( )

inherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT.acquire.ComponentList.

Returns

A unique identifier for the component referenced by this object.

restoreDefault()

ComponentCollection restoreDefault ( )

inherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note

The caller must have the right to modify the component. Otherwise an exception will be thrown.

Returns

A const reference to the component.

swigRelease() [1/2]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

swigRelease() [2/2]

static long swigRelease ( ImageMemoryManager obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited