Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

L1394::CameraRegister Class Reference
[L1394_Register]

This class defines the interface of an L1394 Register for Cameras. More...

#include <l1394_cameraregister.h>

Inheritance diagram for L1394::CameraRegister:

L1394::AvcCameraRegister L1394::DccRegister List of all members.

Public Member Functions

CameraRegister constructor
These functions creates the Register objects for Camera devices.

virtual ~CameraRegister ()
 destructor
Camera_register Interface
These functions defines how to execute a feature of class Camera.

virtual bool onePush (const bool one_push=true) const =0
 This method activates or deactivates one-push mode of a feature.
virtual bool automatic (const bool on=true) const =0
 This method activates or deactivates the automode of a feature.
virtual int setTriggerMode (const int value) const =0
 This method sets the trigger mode.
virtual bool setTriggerPolarity (const bool value) const =0
 This method sets trigger polarity to value (False = low active).
virtual int setValue (const int value) const =0
 This method change the value of a feature.
virtual int getValue () const =0
 This method returns the current value of a feature.
virtual int getMinValue () const =0
 This method returns the minimal value of a feature.
virtual int getMaxValue () const =0
 This method returns the maximal value of a feature.
virtual bool on (const bool=true) const =0
 This method enables or disables a feature.
virtual bool hasFeature () const =0
 This method tests if a feature is supported by a camera.
virtual bool hasOnePush () const =0
 This method tests, if one-push mode is supported by a camera.
virtual bool hasReadout () const =0
 This method tests for readout mode of a feature.
virtual bool hasOnOff () const =0
 This method tests, if on-off mode is support by a feature.
virtual bool hasAuto () const =0
 This method tests for auto mode of a feature.
virtual bool hasManual () const =0
 This method tests for manual mode of a feature.

Detailed Description

This class defines the interface of an L1394 Register for Cameras.

If you access a feature of a device a so called L1394 Register object is returned. The L1394 Register object provides functions to define how to execute the feature.

The functions of this class define, how to execute commands of a Camera.
If you store a pointer to a L1394 Register object remember, that the functions of this class are only valid for the last feature called by the Device.

Functions changing the status of the camera, like setValue(int) return the new value. So you can test, if the new value is set correct.

Illegal combinations are ignored.

For an example see class Camera.

Author:
Michael Repplinger

Definition at line 45 of file l1394_cameraregister.h.


Constructor & Destructor Documentation

L1394::CameraRegister::~CameraRegister  )  [inline, virtual]
 

destructor

Definition at line 55 of file l1394_cameraregister.h.


Member Function Documentation

L1394::CameraRegister::automatic const bool  on = true  )  const [pure virtual]
 

This method activates or deactivates the automode of a feature.

Parameters:
on : enable or disable automatic mode for a feature.
Returns:
bool : new status of automatic mode.

Implemented in L1394::AvcCameraRegister, and L1394::DccRegister.

L1394::CameraRegister::getMaxValue  )  const [pure virtual]
 

This method returns the maximal value of a feature.

Returns:
int : maximal value of a feature

Implemented in L1394::AvcCameraRegister, and L1394::DccRegister.

L1394::CameraRegister::getMinValue  )  const [pure virtual]
 

This method returns the minimal value of a feature.

Returns:
int : minimal value of a feature

Implemented in L1394::AvcCameraRegister, and L1394::DccRegister.

L1394::CameraRegister::getValue  )  const [pure virtual]
 

This method returns the current value of a feature.

Returns:
int : value of a feature.

Implemented in L1394::AvcCameraRegister, and L1394::DccRegister.

L1394::CameraRegister::hasAuto  )  const [pure virtual]
 

This method tests for auto mode of a feature.

Returns:
bool : true if mode is supported, false if not.

Implemented in L1394::AvcCameraRegister, and L1394::DccRegister.

L1394::CameraRegister::hasFeature  )  const [pure virtual]
 

This method tests if a feature is supported by a camera.

Returns:
bool : true if feature is supported, false if not.

Implemented in L1394::AvcCameraRegister, and L1394::DccRegister.

L1394::CameraRegister::hasManual  )  const [pure virtual]
 

This method tests for manual mode of a feature.

Returns:
bool : true if feature has manual support, false if not.

Implemented in L1394::AvcCameraRegister, and L1394::DccRegister.

L1394::CameraRegister::hasOnePush  )  const [pure virtual]
 

This method tests, if one-push mode is supported by a camera.

Returns:
bool : true if a feature supported this mode, false if not.

Implemented in L1394::AvcCameraRegister, and L1394::DccRegister.

L1394::CameraRegister::hasOnOff  )  const [pure virtual]
 

This method tests, if on-off mode is support by a feature.

Returns:
bool : true if a feature support this mode, false if not.

Implemented in L1394::AvcCameraRegister, and L1394::DccRegister.

L1394::CameraRegister::hasReadout  )  const [pure virtual]
 

This method tests for readout mode of a feature.

Returns:
bool : true if a feature support this mode, false if not.

Implemented in L1394::AvcCameraRegister, and L1394::DccRegister.

L1394::CameraRegister::on const   bool = true  )  const [pure virtual]
 

This method enables or disables a feature.

After disabling a feature, no write access has affect until enabling the feature again. So this method can be used, to lock (unlock) a feature to a value.

Parameters:
set : true enable, false disable the feature.

Implemented in L1394::AvcCameraRegister.

L1394::CameraRegister::onePush const bool  one_push = true  )  const [pure virtual]
 

This method activates or deactivates one-push mode of a feature.

Parameters:
one_push : enable or disable one_push
Returns:
bool : new status of one-push mode.

Implemented in L1394::AvcCameraRegister, and L1394::DccRegister.

L1394::CameraRegister::setTriggerMode const int  value  )  const [pure virtual]
 

This method sets the trigger mode.

This method works only combined with the trigger feature.

Parameters:
value : new value for trigger mode.
Returns:
int : value after changing the trigger mode.

Implemented in L1394::AvcCameraRegister, and L1394::DccRegister.

L1394::CameraRegister::setTriggerPolarity const bool  value  )  const [pure virtual]
 

This method sets trigger polarity to value (False = low active).

This method works only combined with the trigger feature.

Parameters:
value : new value for trigger mode.
Returns:
bool : status after changing trigger mode

Implemented in L1394::AvcCameraRegister, and L1394::DccRegister.

L1394::CameraRegister::setValue const int  value  )  const [pure virtual]
 

This method change the value of a feature.

Parameters:
value : new value for the feature
Returns:
int : value after changing new value.

Implemented in L1394::AvcCameraRegister, and L1394::DccRegister.


The documentation for this class was generated from the following file:
Generated on Wed Aug 24 00:36:43 2005 for L1394 by doxygen 1.4.2
L1394 library (NMM) grahics.cs.uni-sb.de/~repplix/l1394_home/