Impact Acquire SDK Java
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
CameraDescriptionManager Class Reference
Device Specific Interface Layout

Grants access to camera description objects(Device specific interface layout only) (deprecated. More...

Public Member Functions

CameraDescriptionCameraLink cameraDescriptionCameraLink (long index)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionCameraLink object specifying the camera description found at the given index in the camera description managers internal list.
 
CameraDescriptionCameraLink cameraDescriptionCameraLink (String name)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionCameraLink object specifying the camera description with the given name in the camera description managers internal list.
 
CameraDescriptionDigital cameraDescriptionDigital (long index)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionDigital object specifying the camera description found at the given index in the camera description managers internal list.
 
CameraDescriptionDigital cameraDescriptionDigital (String name)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionDigital object specifying the camera description with the given name in the camera description managers internal list.
 
 CameraDescriptionManager (CameraDescriptionManager src)
 Constructs a new mvIMPACT.acquire.CameraDescriptionManager from an existing one.
 
CameraDescriptionNonStandard cameraDescriptionNonStandard (long index)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionNonStandard object specifying the camera description found at the given index in the camera description managers internal list.
 
CameraDescriptionNonStandard cameraDescriptionNonStandard (String name)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionNonStandard object specifying the camera description with the given name in the camera description managers internal list.
 
CameraDescriptionSDI cameraDescriptionSDI (long index)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionSDI object specifying the camera description found at the given index in the camera description managers internal list.
 
CameraDescriptionSDI cameraDescriptionSDI (String name)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionSDI object specifying the camera description with the given name in the camera description managers internal list.
 
CameraDescriptionStandard cameraDescriptionStandard (long index)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionStandard object specifying the camera description found at the given index in the camera description managers internal list.
 
CameraDescriptionStandard cameraDescriptionStandard (String name)
 Returns a pointer to a mvIMPACT.acquire.CameraDescriptionStandard object specifying the camera description with the given name in the camera description managers internal list.
 
synchronized void delete ()
 
long getCLCameraDescriptionCount ()
 Returns the number of CameraLink® camera descriptions currently available for the device that constructed this instance of the class.
 
long getDigitalCameraDescriptionCount ()
 Returns the number of non-standard digital camera descriptions currently available for the device that constructed this instance of the class.
 
long getNonStandardCameraDescriptionCount ()
 Returns the number of non-standard camera descriptions currently available for the device that constructed this instance of the class.
 
long getSDICameraDescriptionCount ()
 Returns the number of SDI camera descriptions currently available for the device that constructed this instance of the class.
 
long getStandardCameraDescriptionCount ()
 Returns the number of standard camera descriptions currently available for the device that constructed this instance of the class.
 
long getTotalCameraDescriptionCount ()
 Returns the total number camera descriptions currently available for the device that constructed this instance of the class.
 

Protected Member Functions

 CameraDescriptionManager (long cPtr, boolean cMemoryOwn)
 
void finalize ()
 

Static Protected Member Functions

static long swigRelease (CameraDescriptionManager obj)
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

Grants access to camera description objects(Device specific interface layout only) (deprecated.

Deprecated
Beginning with the release of 3.0.0 of Impact Acquire everything specifically related to frame grabber boards will be considered as deprecated and might be removed without further notice!

This class provides access to the various camera description objects. Each device recognizes a different set of camera descriptions. E.g. a digital frame grabber will not be able to work with analogue cameras. Each camera description class will be derived from mvIMPACT.acquire.CameraDescriptionBase.

Note
Please note that instances of this class will ONLY list camera descriptions that have once been selected by the property mvIMPACT.acquire.CameraSettingsFrameGrabber.getType() at runtime. This is to save memory. A complete list of camera descriptions available for the current device therefore can only be queried by reading the the translation dictionary of the property mvIMPACT.acquire.CameraSettingsFrameGrabber.getType().
import mvIMPACT.acquire.*;
//-----------------------------------------------------------------------------
public class ListCameraDescriptions
//-----------------------------------------------------------------------------
{
static
{
try
{
System.loadLibrary( "mvIMPACT_Acquire.java" );
}
catch( UnsatisfiedLinkError e )
{
System.err.println( "Native code library failed to load. Make sure the 'mvIMPACT_Acquire.java' library can be found in the systems search path.\n" + e );
System.exit( 1 );
}
}
//-----------------------------------------------------------------------------
public static void main( String[] args )
//-----------------------------------------------------------------------------
{
DeviceManager devMgr = new DeviceManager();
Device pDev = mvIMPACT.acquire.examples.helper.DeviceAccess.getDeviceFromUserInput( devMgr );
if( pDev == null )
{
System.out.print( "Unable to continue!" );
mvIMPACT.acquire.examples.helper.DeviceAccess.waitForENTER();
System.exit( 1 );
}
System.out.println( "Initialising the device. This might take some time..." );
try
{
pDev.open();
}
catch( ImpactAcquireException e )
{
// this e.g. might happen if the same device is already opened in another process...
System.out.println( "An error occurred while opening device " + pDev.getSerial().read() +
"(error code: " + e.getMessage() + ")." );
mvIMPACT.acquire.examples.helper.DeviceAccess.waitForENTER();
System.exit( 1 );
}
// display the name of every camera description available for this device.
// this might be less than the number of camera descriptions available on the system as e.g.
// an analog frame grabber can't use descriptions for digital cameras
CameraSettingsFrameGrabber cs = new CameraSettingsFrameGrabber(pDev);
StringIntVector vAvailableDescriptions = new StringIntVector();
cs.getType().getTranslationDict( vAvailableDescriptions );
System.out.println( String.format( "\nAvailable camera descriptions: %d", vAvailableDescriptions.size() ) );
System.out.println( "----------------------------------" );
for( int i=0; i<vAvailableDescriptions.size(); i++ )
{
System.out.println( String.format( "[%d]: %s", vAvailableDescriptions.get( i ).getSecond(), vAvailableDescriptions.get( i ).getFirst() ) );
}
// list all descriptions that already have been selected at least once
CameraDescriptionManager camMgr = new CameraDescriptionManager( pDev );
long camCnt = camMgr.getCLCameraDescriptionCount();
System.out.println( String.format( "Available CL descriptions: %d", camCnt ) );
for( long a=0; a<camCnt; a++ )
{
System.out.println( " " + camMgr.cameraDescriptionCameraLink( a ).getName().read() );
}
camCnt = camMgr.getStandardCameraDescriptionCount();
System.out.println( String.format( "Available Std descriptions: %d", camCnt ) );
for( long b=0; b<camCnt; b++ )
{
System.out.println( " " + camMgr.cameraDescriptionStandard( b ).getName().read() );
}
camCnt = camMgr.getNonStandardCameraDescriptionCount();
System.out.println( String.format( "Available NonStd descriptions: %d", camCnt ) );
for( long c=0; c<camCnt; c++ )
{
System.out.println( " " + camMgr.cameraDescriptionNonStandard( c ).getName().read() );
}
}
}
Note
This class will only be available for frame grabber devices. For other devices the class constructor will raise an exception.
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

◆ CameraDescriptionManager() [1/2]

CameraDescriptionManager ( long cPtr,
boolean cMemoryOwn )
protected

◆ CameraDescriptionManager() [2/2]

CameraDescriptionManager ( CameraDescriptionManager src)

Constructs a new mvIMPACT.acquire.CameraDescriptionManager from an existing one.

Parameters
srcA constant reference to the mvIMPACT.acquire.CameraDescriptionManager object, this object shall be created from

Member Function Documentation

◆ cameraDescriptionCameraLink() [1/2]

CameraDescriptionCameraLink cameraDescriptionCameraLink ( long index)

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionCameraLink object specifying the camera description found at the given index in the camera description managers internal list.

Parameters
index[in] The index of the camera description to return

◆ cameraDescriptionCameraLink() [2/2]

CameraDescriptionCameraLink cameraDescriptionCameraLink ( String name)

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionCameraLink object specifying the camera description with the given name in the camera description managers internal list.

Returns
  • a pointer to a mvIMPACT.acquire.CameraDescriptionCameraLink object specifying the camera description with the given name in the camera description managers internal list if a camera description with name is available.
  • an invalid pointer or reference otherwise.
Parameters
name[in] The name of the camera description. This can either be the name of the list like e.g. 'CameraLink_Generic' or the value of the property 'name' of this description like e.g. 'Generic'.

◆ cameraDescriptionDigital() [1/2]

CameraDescriptionDigital cameraDescriptionDigital ( long index)

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionDigital object specifying the camera description found at the given index in the camera description managers internal list.

Parameters
index[in] The index of the camera description to return

◆ cameraDescriptionDigital() [2/2]

CameraDescriptionDigital cameraDescriptionDigital ( String name)

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionDigital object specifying the camera description with the given name in the camera description managers internal list.

Returns
  • a pointer to a mvIMPACT.acquire.CameraDescriptionDigital object specifying the camera description with the given name in the camera description managers internal list if a camera description with name is available.
  • an invalid pointer or reference otherwise.
Parameters
name[in] The name of the camera description. This can either be the name of the list like e.g. 'Digital_Generic' or the value of the property 'name' of this description like e.g. 'Generic'.

◆ cameraDescriptionNonStandard() [1/2]

CameraDescriptionNonStandard cameraDescriptionNonStandard ( long index)

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionNonStandard object specifying the camera description found at the given index in the camera description managers internal list.

Parameters
index[in] The index of the camera description to return

◆ cameraDescriptionNonStandard() [2/2]

CameraDescriptionNonStandard cameraDescriptionNonStandard ( String name)

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionNonStandard object specifying the camera description with the given name in the camera description managers internal list.

Returns
  • a pointer to a mvIMPACT.acquire.CameraDescriptionNonStandard object specifying the camera description with the given name in the camera description managers internal list if a camera description with name is available.
  • an invalid pointer or reference otherwise.
Parameters
name[in] The name of the camera description. This can either be the name of the list like e.g. 'NonStandard_Generic' or the value of the property 'name' of this description like e.g. 'Generic'.

◆ cameraDescriptionSDI() [1/2]

CameraDescriptionSDI cameraDescriptionSDI ( long index)

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionSDI object specifying the camera description found at the given index in the camera description managers internal list.

Parameters
index[in] The index of the camera description to return

◆ cameraDescriptionSDI() [2/2]

CameraDescriptionSDI cameraDescriptionSDI ( String name)

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionSDI object specifying the camera description with the given name in the camera description managers internal list.

Returns
  • a pointer to a mvIMPACT.acquire.CameraDescriptionSDI object specifying the camera description with the given name in the camera description managers internal list if a camera description with name is available.
  • an invalid pointer or reference otherwise.
Parameters
name[in] The name of the camera description. This can either be the name of the list like e.g. 'CameraLink_Generic' or the value of the property 'name' of this description like e.g. 'Generic'.

◆ cameraDescriptionStandard() [1/2]

CameraDescriptionStandard cameraDescriptionStandard ( long index)

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionStandard object specifying the camera description found at the given index in the camera description managers internal list.

Parameters
index[in] The index of the camera description to return

◆ cameraDescriptionStandard() [2/2]

CameraDescriptionStandard cameraDescriptionStandard ( String name)

Returns a pointer to a mvIMPACT.acquire.CameraDescriptionStandard object specifying the camera description with the given name in the camera description managers internal list.

Returns
  • a pointer to a mvIMPACT.acquire.CameraDescriptionStandard object specifying the camera description with the given name in the camera description managers internal list if a camera description with name is available.
  • an invalid pointer or reference otherwise.
Parameters
name[in] The name of the camera description. This can either be the name of the list like e.g. 'Standard_Generic' or the value of the property 'name' of this description like e.g. 'Generic'.

◆ delete()

synchronized void delete ( )

◆ finalize()

void finalize ( )
protected

◆ getCLCameraDescriptionCount()

long getCLCameraDescriptionCount ( )

Returns the number of CameraLink® camera descriptions currently available for the device that constructed this instance of the class.

◆ getDigitalCameraDescriptionCount()

long getDigitalCameraDescriptionCount ( )

Returns the number of non-standard digital camera descriptions currently available for the device that constructed this instance of the class.

◆ getNonStandardCameraDescriptionCount()

long getNonStandardCameraDescriptionCount ( )

Returns the number of non-standard camera descriptions currently available for the device that constructed this instance of the class.

◆ getSDICameraDescriptionCount()

long getSDICameraDescriptionCount ( )

Returns the number of SDI camera descriptions currently available for the device that constructed this instance of the class.

◆ getStandardCameraDescriptionCount()

long getStandardCameraDescriptionCount ( )

Returns the number of standard camera descriptions currently available for the device that constructed this instance of the class.

◆ getTotalCameraDescriptionCount()

long getTotalCameraDescriptionCount ( )

Returns the total number camera descriptions currently available for the device that constructed this instance of the class.

Since
2.1.4

◆ swigRelease()

static long swigRelease ( CameraDescriptionManager obj)
staticprotected

Member Data Documentation

◆ swigCMemOwn

transient boolean swigCMemOwn
protected