CameraDescriptionManager Class Reference

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

Public Member Functions
CameraDescriptionCameraLink	cameraDescriptionCameraLink (int index)
	Returns a pointer to a mv.impact.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 mv.impact.acquire.CameraDescriptionCameraLink object specifying the camera description with the given name in the camera description managers internal list.
CameraDescriptionDigital	cameraDescriptionDigital (int index)
	Returns a pointer to a mv.impact.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 mv.impact.acquire.CameraDescriptionDigital object specifying the camera description with the given name in the camera description managers internal list.
	CameraDescriptionManager (Device device)
	Constructs a new mv.impact.acquire.CameraDescriptionManager object.
CameraDescriptionNonStandard	cameraDescriptionNonStandard (int index)
	Returns a pointer to a mv.impact.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 mv.impact.acquire.CameraDescriptionNonStandard object specifying the camera description with the given name in the camera description managers internal list.
CameraDescriptionSDI	cameraDescriptionSDI (int index)
	Returns a pointer to a mv.impact.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 mv.impact.acquire.CameraDescriptionSDI object specifying the camera description with the given name in the camera description managers internal list.
CameraDescriptionStandard	cameraDescriptionStandard (int index)
	Returns a pointer to a mv.impact.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 mv.impact.acquire.CameraDescriptionStandard object specifying the camera description with the given name in the camera description managers internal list.
CameraDescriptionBase	getDescription (String name)
	Returns a pointer to a mv.impact.acquire.CameraDescriptionBase object specifying the camera description with the given name in the camera description managers internal list.

Properties
int	CLCameraDescriptionCount [get]
	Returns the number of CameraLink® camera descriptions currently available for the device that constructed this instance of the class.
int	digitalCameraDescriptionCount [get]
	Returns the number of non-standard digital camera descriptions currently available for the device that constructed this instance of the class.
int	nonStandardCameraDescriptionCount [get]
	Returns the number of non-standard camera descriptions currently available for the device that constructed this instance of the class.
int	SDICameraDescriptionCount [get]
	Returns the number of SDI camera descriptions currently available for the device that constructed this instance of the class.
int	standardCameraDescriptionCount [get]
	Returns the number of standard camera descriptions currently available for the device that constructed this instance of the class.
int	totalCameraDescriptionCount [get]
	Returns the total number of camera descriptions currently available for the device that constructed this instance of the class.

Detailed Description

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

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 mv.impact.acquire.CameraDescriptionBase.

Note

Please note that instances of this class will ONLY list camera descriptions that have once been selected by the property mv.impact.acquire.CameraSettingsFrameGrabber.type 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 mv.impact.acquire.CameraSettingsFrameGrabber.type.

Example (lists all available camera descriptions for a certain device)

using mv.impact.acquire;
 
//-----------------------------------------------------------------------------
static void Main(string[] args)
//-----------------------------------------------------------------------------
{
  Device pDev = DeviceManager.getDevice(0);
  if (pDev == null)
  {
    Console.WriteLine("No device found");
    return;
  }
 
  // 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);
  List<KeyValuePair<String, int>> availableDescriptions = new List<KeyValuePair<string, int>>();
  cs.type.getTranslationDict(vAvailableDescriptions);
  Console.WriteLine("Available camera descriptions: {0}", availableDescriptions.Count);
  Console.WriteLine("----------------------------------");
  for (int i = 0; i < availableDescriptions.Count; i++)
  {
    Console.WriteLine("{0}: {1}", availableDescriptions[i].Key, availableDescriptions[i].Value);
  }
 
  // list all descriptions that already have been selected at least once
  CameraDescriptionManager camMgr = new CameraDescriptionManager(pDev);
  int camCnt = camMgr.CLCameraDescriptionCount;
  Console.WriteLine("Available CL descriptions: {0}", camCnt);
  for (int a = 0; a < camCnt; a++)
  {
    Console.WriteLine("  {0}", camMgr.cameraDescriptionCameraLink(a).name.read());
  }
  camCnt = camMgr.standardCameraDescriptionCount;
  Console.WriteLine("Available Std descriptions: {0}", camCnt);
  for (int b = 0; b < camCnt; b++)
  {
    Console.WriteLine("  {0}", camMgr.cameraDescriptionStandard(b).name.read());
  }
  camCnt = camMgr.nonStandardCameraDescriptionCount;
  Console.WriteLine("Available NonStd descriptions: {0}", camCnt);
  for (int c = 0; c < camCnt; c++)
  {
    Console.WriteLine("  ", camMgr.cameraDescriptionNonStandard(c).name.read());
  }
  return;
}

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 mv.impact.acquire.Device.interfaceLayout is set to mv.impact.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

CameraDescriptionManager()

CameraDescriptionManager ( Device device )

inline

Constructs a new mv.impact.acquire.CameraDescriptionManager object.

Parameters

[in]

device

A pointer to a mv.impact.acquire.Device object obtained from a mv.impact.acquire.DeviceManager object.

Member Function Documentation

cameraDescriptionCameraLink() [1/2]

CameraDescriptionCameraLink cameraDescriptionCameraLink ( int index )

inline

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

Parameters

[in]

index

The index of the camera description to return

cameraDescriptionCameraLink() [2/2]

CameraDescriptionCameraLink cameraDescriptionCameraLink ( String name )

inline

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

Returns

• a pointer to a mv.impact.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

[in]

name

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 ( int index )

inline

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

Parameters

[in]

index

The index of the camera description to return

cameraDescriptionDigital() [2/2]

CameraDescriptionDigital cameraDescriptionDigital ( String name )

inline

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

Returns

• a pointer to a mv.impact.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

[in]

name

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 ( int index )

inline

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

Parameters

[in]

index

The index of the camera description to return

cameraDescriptionNonStandard() [2/2]

CameraDescriptionNonStandard cameraDescriptionNonStandard ( String name )

inline

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

Returns

• a pointer to a mv.impact.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

[in]

name

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 ( int index )

inline

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

Parameters

[in]

index

The index of the camera description to return

cameraDescriptionSDI() [2/2]

CameraDescriptionSDI cameraDescriptionSDI ( String name )

inline

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

Returns

• a pointer to a mv.impact.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

[in]

name

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 ( int index )

inline

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

Parameters

[in]

index

The index of the camera description to return

cameraDescriptionStandard() [2/2]

CameraDescriptionStandard cameraDescriptionStandard ( String name )

inline

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

Returns

• a pointer to a mv.impact.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

[in]

name

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'.

getDescription()

CameraDescriptionBase getDescription ( String name )

inline

Returns a pointer to a mv.impact.acquire.CameraDescriptionBase object specifying the camera description with the given name in the camera description managers internal list.

Returns

• a pointer to a mv.impact.acquire.CameraDescriptionBase 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

[in]

name

The name of the camera description to return.

Property Documentation

CLCameraDescriptionCount

int CLCameraDescriptionCount

get

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

digitalCameraDescriptionCount

int digitalCameraDescriptionCount

get

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

nonStandardCameraDescriptionCount

int nonStandardCameraDescriptionCount

get

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

SDICameraDescriptionCount

int SDICameraDescriptionCount

get

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

standardCameraDescriptionCount

int standardCameraDescriptionCount

get

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

totalCameraDescriptionCount

int totalCameraDescriptionCount

get

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