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

L1394::DccRegister Class Reference
[L1394_Register]

Class DccRegister implements the interface of class CameraRegister for DccCameras. More...

#include <l1394_dccregister.h>

Inheritance diagram for L1394::DccRegister:

L1394::CameraRegister List of all members.

Public Member Functions

DccRegister constructor
These functions creates the DccRegister for DccCameras.

 DccRegister (const Node *parent)
 constructor
virtual ~DccRegister ()
 destructor
Camera_register Interface
These functions implement the CameraRegister interface for DccCameras

virtual bool onePush (const bool one_push=true) const
 This method activates or deactivates one-push mode of a feature.
virtual bool on (const bool on=true) const
 This method enables or disables a feature.
virtual bool automatic (const bool on=true) const
 This method activates or deactivates the automode of a feature.
virtual int setValue (const int value) const
 This method changes the parameter of a feature.
virtual int setTriggerMode (const int value) const
 This method changes the trigger mode of a feature.
virtual bool setTriggerPolarity (const bool value) const
 This method sets trigger polarity to value (False = low active).
virtual int getValue () const
 This method returns the actual value of a feature.
virtual int getMinValue () const
 This method returns the minimum value of a feature.
virtual int getMaxValue () const
 This method returns the maximum value of a feature.
virtual bool hasFeature () const
 This method tests if a feature is supported by a camera.
virtual bool hasOnePush () const
 This method tests, if one-push mode is supported by a camera.
virtual bool hasReadout () const
 This method tests for readout mode of a feature.
virtual bool hasOnOff () const
 This method tests, if on-off mode is supported by a feature.
virtual bool hasAuto () const
 This method tests for auto mode of a feature.
virtual bool hasManual () const
 This method tests for manual mode of a feature.
Some internal functions
These methods help to implement the interface.

DccRegistersetOffset (int offset)
 This method set the offset register to access a feature.
DccRegistersetWhiteBalance (bool value)
 This method is for internal use only!! DON'T use it.

Detailed Description

Class DccRegister implements the interface of class CameraRegister for DccCameras.

As described in class CameraRegister, class DccRegister defines how to execute a command of class DccCamera .

For example see class DccCamera or class Camera.

Illegal combinations are ignored.

Author:
Michael Repplinger

Definition at line 44 of file l1394_dccregister.h.


Constructor & Destructor Documentation

L1394::DccRegister::DccRegister const Node parent  ) 
 

constructor

Parameters:
Node* parent pointer to parent node

Definition at line 22 of file l1394_dccregister.cpp.

References L1394::Quadlet::fromInt(), and L1394::Singleton< T, CreationPolicy, LifetimePolicy, ThreadingModel >::getInstance().

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

destructor

Definition at line 62 of file l1394_dccregister.h.


Member Function Documentation

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

This method activates or deactivates the automode of a feature.

Parameters:
on : true enables, false disables the automatic mode of a feature.
Returns:
bool : new status of automatic mode.

Implements L1394::CameraRegister.

Definition at line 65 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBit(), L1394_FAILED, and L1394::Quadlet::setBit().

L1394::DccRegister::getMaxValue  )  const [virtual]
 

This method returns the maximum value of a feature.

Returns:
int : returns the maximum value of a feature.

Implements L1394::CameraRegister.

Definition at line 171 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBitRange(), and L1394_FAILED.

L1394::DccRegister::getMinValue  )  const [virtual]
 

This method returns the minimum value of a feature.

Returns:
int : returns the minimum value of a feature.

Implements L1394::CameraRegister.

Definition at line 162 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBitRange(), and L1394_FAILED.

L1394::DccRegister::getValue  )  const [virtual]
 

This method returns the actual value of a feature.

Returns:
int : actual value of the feature.

Implements L1394::CameraRegister.

Definition at line 146 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBitRange(), and L1394_FAILED.

L1394::DccRegister::hasAuto  )  const [virtual]
 

This method tests for auto mode of a feature.

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

Implements L1394::CameraRegister.

Definition at line 234 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBit(), and L1394_FAILED.

L1394::DccRegister::hasFeature  )  const [virtual]
 

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

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

Implements L1394::CameraRegister.

Definition at line 179 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBit(), and L1394_FAILED.

L1394::DccRegister::hasManual  )  const [virtual]
 

This method tests for manual mode of a feature.

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

Implements L1394::CameraRegister.

Definition at line 242 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBit(), and L1394_FAILED.

L1394::DccRegister::hasOnePush  )  const [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.

Implements L1394::CameraRegister.

Definition at line 211 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBit(), and L1394_FAILED.

L1394::DccRegister::hasOnOff  )  const [virtual]
 

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

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

Implements L1394::CameraRegister.

Definition at line 226 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBit(), and L1394_FAILED.

L1394::DccRegister::hasReadout  )  const [virtual]
 

This method tests for readout mode of a feature.

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

Implements L1394::CameraRegister.

Definition at line 218 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBit(), and L1394_FAILED.

L1394::DccRegister::on const bool  set = true  )  const [virtual]
 

This method enables or disables a feature.

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

Parameters:
set : true enables, false disables the feature.

Definition at line 47 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBit(), L1394_FAILED, and L1394::Quadlet::setBit().

L1394::DccRegister::onePush const bool  one_push = true  )  const [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.

Implements L1394::CameraRegister.

Definition at line 31 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBit(), L1394_FAILED, and L1394::Quadlet::setBit().

L1394::DccRegister::setOffset int  offset  )  [inline]
 

This method set the offset register to access a feature.

This method is for internal use only!!!

Parameters:
offset : new register offset
Returns:
DccRegister* : pointer to this object.

Definition at line 193 of file l1394_dccregister.h.

Referenced by L1394::DccCamera::autoExposure(), L1394::DccCamera::brightness(), L1394::DccCamera::filter(), L1394::DccCamera::focus(), L1394::DccCamera::gain(), L1394::DccCamera::gamma(), L1394::DccCamera::hue(), L1394::DccCamera::iris(), L1394::DccCamera::pan(), L1394::DccCamera::saturation(), L1394::DccCamera::sharpness(), L1394::DccCamera::shutter(), L1394::DccCamera::temperature(), L1394::DccCamera::tilt(), L1394::DccCamera::trigger(), L1394::DccCamera::whiteBalance(), and L1394::DccCamera::zoom().

L1394::DccRegister::setTriggerMode const int  value  )  const [virtual]
 

This method changes the trigger mode of a feature.

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

Implements L1394::CameraRegister.

Definition at line 114 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBitRange(), L1394_FAILED, and L1394::Quadlet::setBitRange().

L1394::DccRegister::setTriggerPolarity const bool  value  )  const [virtual]
 

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

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

Implements L1394::CameraRegister.

Definition at line 129 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBit(), L1394_FAILED, and L1394::Quadlet::setBit().

L1394::DccRegister::setValue const int  value  )  const [virtual]
 

This method changes the parameter of a feature.

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

Implements L1394::CameraRegister.

Definition at line 84 of file l1394_dccregister.cpp.

References DCC_BASE, L1394::internal::Message::errorStream(), L1394::Quadlet::getBitRange(), L1394_FAILED, and L1394::Quadlet::setBitRange().

L1394::DccRegister::setWhiteBalance bool  value  )  [inline]
 

This method is for internal use only!! DON'T use it.

This method sets the bit range for writing values to a register. This method will be removed in later versions.

Parameters:
value : true for bit range 12..23, false for 0..11
Returns:
DccRegister* : pointer to this object.

Definition at line 203 of file l1394_dccregister.h.


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