GENAPI_NAMESPACE::IFirmwareUpdatableDevice Class Reference

Represents a device that can be updated. More...

#include <FirmwareUpdatableDevice.h>

Inheritance diagram for GENAPI_NAMESPACE::IFirmwareUpdatableDevice:

Public Member Functions
virtual void	CleanupAfterFirmwareUpdate ()=0
	Cleanup after firmware update. More...
virtual INodeMap *	DeviceResetWhileUpdatingFirmware (unsigned int EstimatedDurationMs, unsigned int DelayEnumerationMs)=0
	Perform a device reset while updating the device. More...
virtual GENICAM_NAMESPACE::gcstring	GetDisplayName ()=0
	Returns a display name for this camera. More...
virtual INodeMap *	GetNodeMapOfDeviceToUpdate ()=0
	Get the node map of the device to update. More...
virtual void	PrepareForFirmwareUpdate ()=0
	Prepare for an firmware update. More...
Public Member Functions inherited from GENAPI_NAMESPACE::IDestructible
virtual	~IDestructible ()
	Default implementation of destructor. More...

Detailed Description

Represents a device that can be updated.

This interface is needed because GenICam does not know the actual SDK running an firmware update. It is required to write a wrapper class implementing this interface.

Definition at line 41 of file FirmwareUpdatableDevice.h.

Member Function Documentation

CleanupAfterFirmwareUpdate()

virtual void GENAPI_NAMESPACE::IFirmwareUpdatableDevice::CleanupAfterFirmwareUpdate ( )

pure virtual

Cleanup after firmware update.

Close the device if needed.

Can throw C++ exceptions.

DeviceResetWhileUpdatingFirmware()

virtual INodeMap* GENAPI_NAMESPACE::IFirmwareUpdatableDevice::DeviceResetWhileUpdatingFirmware ( unsigned int  EstimatedDurationMs, unsigned int  DelayEnumerationMs  )

pure virtual

Perform a device reset while updating the device.

Reset the camera device. Rediscover, create and open the device. This is also needed if a reset is the last step to assure that the upload succeeded.

Parameters

EstimatedDurationMs	This is the estimated time in milliseconds for this reset. Actual time may vary. Note that the Duration information is an optional value in the control XML file, so this can be 0 - Use a reasonable default value in this case.
DelayEnumerationMs	This is the time required by the device until it can be enumerated again.

Returns

Return the new node map created by creating a new device.

Throws C++ exceptions if accessing or the device fails.

GetDisplayName()

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::IFirmwareUpdatableDevice::GetDisplayName ( )

pure virtual

Returns a display name for this camera.

This is used for display/logging purposes.

Throws C++ exceptions if not available.

GetNodeMapOfDeviceToUpdate()

virtual INodeMap* GENAPI_NAMESPACE::IFirmwareUpdatableDevice::GetNodeMapOfDeviceToUpdate ( )

pure virtual

Get the node map of the device to update.

return The node map of the device to update. Never returns NULL.

Does not throw C++ exceptions.

PrepareForFirmwareUpdate()

virtual void GENAPI_NAMESPACE::IFirmwareUpdatableDevice::PrepareForFirmwareUpdate ( )

pure virtual

Prepare for an firmware update.

Store information, e.g. for rediscovering a device after reset, e.g. serial number, MAC address or other information. What needs to be stored depends on the actual transport layer used. Open the device for running the update if the device is not already open.

Throws C++ exceptions if accessing the device fails.

---

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

• FirmwareUpdatableDevice.h