Fawkes API  Fawkes Development Version
fawkes::CameraControlInterface Class Reference

CameraControlInterface Fawkes BlackBoard Interface. More...

#include <>>

Inheritance diagram for fawkes::CameraControlInterface:

Classes

class  SetEffectMessage
 SetEffectMessage Fawkes BlackBoard Interface Message. More...
 
class  SetMirrorMessage
 SetMirrorMessage Fawkes BlackBoard Interface Message. More...
 
class  SetZoomMessage
 SetZoomMessage Fawkes BlackBoard Interface Message. More...
 

Public Types

enum  Effect {
  EFF_NONE, EFF_PASTEL, EFF_NEGATIVE, EFF_BW,
  EFF_SOLARIZE
}
 Enumeration defining the possible effects. More...
 

Public Member Functions

const char * tostring_Effect (Effect value) const
 Convert Effect constant to string. More...
 
virtual bool message_valid (const Message *message) const
 Check if message is valid and can be enqueued. More...
 
Effect effect () const
 Get effect value. More...
 
void set_effect (const Effect new_effect)
 Set effect value. More...
 
size_t maxlenof_effect () const
 Get maximum length of effect value. More...
 
bool is_effect_supported () const
 Get effect_supported value. More...
 
void set_effect_supported (const bool new_effect_supported)
 Set effect_supported value. More...
 
size_t maxlenof_effect_supported () const
 Get maximum length of effect_supported value. More...
 
uint32_t zoom () const
 Get zoom value. More...
 
void set_zoom (const uint32_t new_zoom)
 Set zoom value. More...
 
size_t maxlenof_zoom () const
 Get maximum length of zoom value. More...
 
bool is_zoom_supported () const
 Get zoom_supported value. More...
 
void set_zoom_supported (const bool new_zoom_supported)
 Set zoom_supported value. More...
 
size_t maxlenof_zoom_supported () const
 Get maximum length of zoom_supported value. More...
 
uint32_t zoom_max () const
 Get zoom_max value. More...
 
void set_zoom_max (const uint32_t new_zoom_max)
 Set zoom_max value. More...
 
size_t maxlenof_zoom_max () const
 Get maximum length of zoom_max value. More...
 
uint32_t zoom_min () const
 Get zoom_min value. More...
 
void set_zoom_min (const uint32_t new_zoom_min)
 Set zoom_min value. More...
 
size_t maxlenof_zoom_min () const
 Get maximum length of zoom_min value. More...
 
bool is_mirror () const
 Get mirror value. More...
 
void set_mirror (const bool new_mirror)
 Set mirror value. More...
 
size_t maxlenof_mirror () const
 Get maximum length of mirror value. More...
 
bool is_mirror_supported () const
 Get mirror_supported value. More...
 
void set_mirror_supported (const bool new_mirror_supported)
 Set mirror_supported value. More...
 
size_t maxlenof_mirror_supported () const
 Get maximum length of mirror_supported value. More...
 
virtual Messagecreate_message (const char *type) const
 Create message based on type name. More...
 
virtual void copy_values (const Interface *other)
 Copy values from other interface. More...
 
virtual const char * enum_tostring (const char *enumtype, int val) const
 Convert arbitrary enum value to string. More...
 
- Public Member Functions inherited from fawkes::Interface
virtual ~Interface ()
 Destructor. More...
 
bool oftype (const char *interface_type) const
 Check if interface is of given type. More...
 
const void * datachunk () const
 Get data chunk. More...
 
unsigned int datasize () const
 Get data size. More...
 
const char * type () const
 Get type of interface. More...
 
const char * id () const
 Get identifier of interface. More...
 
const char * uid () const
 Get unique identifier of interface. More...
 
unsigned short serial () const
 Get instance serial of interface. More...
 
unsigned int mem_serial () const
 Get memory serial of interface. More...
 
bool operator== (Interface &comp) const
 Check equality of two interfaces. More...
 
const unsigned char * hash () const
 Get interface hash. More...
 
size_t hash_size () const
 Get size of interface hash. More...
 
const char * hash_printable () const
 Get printable interface hash. More...
 
bool is_writer () const
 Check if this is a writing instance. More...
 
void set_validity (bool valid)
 Mark this interface invalid. More...
 
bool is_valid () const
 Check validity of interface. More...
 
const char * owner () const
 Get owner of interface. More...
 
void set_from_chunk (void *chunk)
 Set from a raw data chunk. More...
 
void resize_buffers (unsigned int num_buffers)
 Resize buffer array. More...
 
unsigned int num_buffers () const
 Get number of buffers. More...
 
void copy_shared_to_buffer (unsigned int buffer)
 Copy data from private memory to buffer. More...
 
void copy_private_to_buffer (unsigned int buffer)
 Copy data from private memory to buffer. More...
 
void read_from_buffer (unsigned int buffer)
 Copy data from buffer to private memory. More...
 
int compare_buffers (unsigned int buffer)
 Compare buffer to private memory. More...
 
Time buffer_timestamp (unsigned int buffer)
 Get time of a buffer. More...
 
void buffer_timestamp (unsigned int buffer, Time *timestamp)
 Get time of a buffer. More...
 
void read ()
 Read from BlackBoard into local copy. More...
 
void write ()
 Write from local copy into BlackBoard memory. More...
 
bool has_writer () const
 Check if there is a writer for the interface. More...
 
unsigned int num_readers () const
 Get the number of readers. More...
 
std::string writer () const
 Get owner name of writing interface instance. More...
 
std::list< std::string > readers () const
 Get owner names of reading interface instances. More...
 
bool changed () const
 Check if data has been changed. More...
 
const Timetimestamp () const
 Get timestamp of last write. More...
 
void set_auto_timestamping (bool enabled)
 Enable or disable automated timestamping. More...
 
void set_timestamp (const Time *t=NULL)
 Set timestamp. More...
 
void set_clock (Clock *clock)
 Set clock to use for timestamping. More...
 
void mark_data_changed ()
 Mark data as changed. More...
 
std::list< const char * > get_message_types ()
 Obtain a list of textual representations of the message types available for this interface. More...
 
unsigned int msgq_enqueue (Message *message)
 Enqueue message at end of queue. More...
 
unsigned int msgq_enqueue_copy (Message *message)
 Enqueue copy of message at end of queue. More...
 
void msgq_remove (Message *message)
 Remove message from queue. More...
 
void msgq_remove (unsigned int message_id)
 Remove message from queue. More...
 
unsigned int msgq_size ()
 Get size of message queue. More...
 
void msgq_flush ()
 Flush all messages. More...
 
void msgq_lock ()
 Lock message queue. More...
 
bool msgq_try_lock ()
 Try to lock message queue. More...
 
void msgq_unlock ()
 Unlock message queue. More...
 
void msgq_pop ()
 Erase first message from queue. More...
 
Messagemsgq_first ()
 Get the first message from the message queue. More...
 
bool msgq_empty ()
 Check if queue is empty. More...
 
void msgq_append (Message *message)
 Enqueue message. More...
 
template<class MessageType >
bool msgq_first_is ()
 Check if first message has desired type. More...
 
template<class MessageType >
MessageType * msgq_first ()
 Get first message casted to the desired type. More...
 
template<class MessageType >
MessageType * msgq_first (MessageType *&msg)
 Get first message casted to the desired type. More...
 
template<class MessageType >
MessageType * msgq_first_safe (MessageType *&msg) throw ()
 Get first message casted to the desired type without exceptions. More...
 
MessageQueue::MessageIterator msgq_begin ()
 Get start iterator for message queue. More...
 
MessageQueue::MessageIterator msgq_end ()
 Get end iterator for message queue. More...
 
InterfaceFieldIterator fields ()
 Get iterator over all fields of this interface instance. More...
 
InterfaceFieldIterator fields_end ()
 Invalid iterator. More...
 
unsigned int num_fields ()
 Get the number of fields in the interface. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from fawkes::Interface
static void parse_uid (const char *uid, std::string &type, std::string &id)
 Parse UID to type and ID strings. More...
 
- Protected Member Functions inherited from fawkes::Interface
 Interface ()
 Constructor. More...
 
void set_hash (unsigned char *ihash)
 Set hash. More...
 
void add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0, const interface_enum_map_t *enum_map=0)
 Add an entry to the field info list. More...
 
void add_messageinfo (const char *name)
 Add an entry to the message info list. More...
 
- Protected Attributes inherited from fawkes::Interface
void * data_ptr
 Pointer to local memory storage. More...
 
unsigned int data_size
 Minimal data size to hold data storage. More...
 
bool data_changed
 Indicator if data has changed. More...
 
interface_data_ts_tdata_ts
 Pointer to data casted to timestamp struct. More...
 

Detailed Description

Member Enumeration Documentation

◆ Effect

Enumeration defining the possible effects.

A camera must not necessarily implement all.

Enumerator
EFF_NONE 

No effect.

EFF_PASTEL 

Pastel colors.

EFF_NEGATIVE 

Negative/Positive Reversal.

EFF_BW 

Monochrome Image.

EFF_SOLARIZE 

Enhanced Contrast.

Definition at line 45 of file CameraControlInterface.h.

Member Function Documentation

◆ copy_values()

void fawkes::CameraControlInterface::copy_values ( const Interface other)
virtual

Copy values from other interface.

Parameters
otherother interface to copy values from

Implements fawkes::Interface.

Definition at line 363 of file CameraControlInterface.cpp.

References fawkes::Message::type(), and fawkes::Interface::type().

◆ create_message()

Message * fawkes::CameraControlInterface::create_message ( const char *  type) const
virtual

Create message based on type name.

This will create a new message of the given type. The type must be given without the InterfaceName:: prefix but just the plain class name of the message.

Parameters
typemessage type
Returns
message of the given type, empty
Exceptions
UnknownTypeExceptionthrown if this interface cannot create a message of the given type.

Implements fawkes::Interface.

Definition at line 344 of file CameraControlInterface.cpp.

◆ effect()

CameraControlInterface::Effect fawkes::CameraControlInterface::effect ( ) const

Get effect value.

Currently active effect.

Returns
effect value

Definition at line 99 of file CameraControlInterface.cpp.

Referenced by PanTiltSonyEviD100PThread::loop().

◆ enum_tostring()

const char * fawkes::CameraControlInterface::enum_tostring ( const char *  enumtype,
int  val 
) const
virtual

Convert arbitrary enum value to string.

Given the string representation of the enum type and the value this method returns the string representation of the specific value, or the string UNKNOWN if the value is not defined. An exception is thrown if the enum type is invalid.

Parameters
enumtypeenum type as string
valvalue to convert
Returns
string representation of value
Exceptions
UnknownTypeExceptionthrown if enumtype is not specified for interface.

Implements fawkes::Interface.

Definition at line 374 of file CameraControlInterface.cpp.

◆ is_effect_supported()

bool fawkes::CameraControlInterface::is_effect_supported ( ) const

Get effect_supported value.

Are effects supported?

Returns
effect_supported value

Definition at line 130 of file CameraControlInterface.cpp.

◆ is_mirror()

bool fawkes::CameraControlInterface::is_mirror ( ) const

Get mirror value.

Is the image mirrored?

Returns
mirror value

Definition at line 285 of file CameraControlInterface.cpp.

Referenced by PanTiltSonyEviD100PThread::loop().

◆ is_mirror_supported()

bool fawkes::CameraControlInterface::is_mirror_supported ( ) const

Get mirror_supported value.

Is mirroring supported?

Returns
mirror_supported value

Definition at line 316 of file CameraControlInterface.cpp.

◆ is_zoom_supported()

bool fawkes::CameraControlInterface::is_zoom_supported ( ) const

Get zoom_supported value.

Is zooming supported?

Returns
zoom_supported value

Definition at line 192 of file CameraControlInterface.cpp.

◆ maxlenof_effect()

size_t fawkes::CameraControlInterface::maxlenof_effect ( ) const

Get maximum length of effect value.

Returns
length of effect value, can be length of the array or number of maximum number of characters for a string

Definition at line 109 of file CameraControlInterface.cpp.

◆ maxlenof_effect_supported()

size_t fawkes::CameraControlInterface::maxlenof_effect_supported ( ) const

Get maximum length of effect_supported value.

Returns
length of effect_supported value, can be length of the array or number of maximum number of characters for a string

Definition at line 140 of file CameraControlInterface.cpp.

◆ maxlenof_mirror()

size_t fawkes::CameraControlInterface::maxlenof_mirror ( ) const

Get maximum length of mirror value.

Returns
length of mirror value, can be length of the array or number of maximum number of characters for a string

Definition at line 295 of file CameraControlInterface.cpp.

◆ maxlenof_mirror_supported()

size_t fawkes::CameraControlInterface::maxlenof_mirror_supported ( ) const

Get maximum length of mirror_supported value.

Returns
length of mirror_supported value, can be length of the array or number of maximum number of characters for a string

Definition at line 326 of file CameraControlInterface.cpp.

◆ maxlenof_zoom()

size_t fawkes::CameraControlInterface::maxlenof_zoom ( ) const

Get maximum length of zoom value.

Returns
length of zoom value, can be length of the array or number of maximum number of characters for a string

Definition at line 171 of file CameraControlInterface.cpp.

◆ maxlenof_zoom_max()

size_t fawkes::CameraControlInterface::maxlenof_zoom_max ( ) const

Get maximum length of zoom_max value.

Returns
length of zoom_max value, can be length of the array or number of maximum number of characters for a string

Definition at line 233 of file CameraControlInterface.cpp.

◆ maxlenof_zoom_min()

size_t fawkes::CameraControlInterface::maxlenof_zoom_min ( ) const

Get maximum length of zoom_min value.

Returns
length of zoom_min value, can be length of the array or number of maximum number of characters for a string

Definition at line 264 of file CameraControlInterface.cpp.

◆ maxlenof_zoom_supported()

size_t fawkes::CameraControlInterface::maxlenof_zoom_supported ( ) const

Get maximum length of zoom_supported value.

Returns
length of zoom_supported value, can be length of the array or number of maximum number of characters for a string

Definition at line 202 of file CameraControlInterface.cpp.

◆ message_valid()

bool fawkes::CameraControlInterface::message_valid ( const Message message) const
virtual

Check if message is valid and can be enqueued.

Parameters
messageMessage to check
Returns
true if the message is valid, false otherwise.

Implements fawkes::Interface.

Definition at line 688 of file CameraControlInterface.cpp.

◆ set_effect()

void fawkes::CameraControlInterface::set_effect ( const Effect  new_effect)

Set effect value.

Currently active effect.

Parameters
new_effectnew effect value

Definition at line 119 of file CameraControlInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by PanTiltSonyEviD100PThread::init(), and PanTiltSonyEviD100PThread::loop().

◆ set_effect_supported()

void fawkes::CameraControlInterface::set_effect_supported ( const bool  new_effect_supported)

Set effect_supported value.

Are effects supported?

Parameters
new_effect_supportednew effect_supported value

Definition at line 150 of file CameraControlInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by PanTiltSonyEviD100PThread::init().

◆ set_mirror()

void fawkes::CameraControlInterface::set_mirror ( const bool  new_mirror)

Set mirror value.

Is the image mirrored?

Parameters
new_mirrornew mirror value

Definition at line 305 of file CameraControlInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by PanTiltSonyEviD100PThread::init(), and PanTiltSonyEviD100PThread::loop().

◆ set_mirror_supported()

void fawkes::CameraControlInterface::set_mirror_supported ( const bool  new_mirror_supported)

Set mirror_supported value.

Is mirroring supported?

Parameters
new_mirror_supportednew mirror_supported value

Definition at line 336 of file CameraControlInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by PanTiltSonyEviD100PThread::init().

◆ set_zoom()

void fawkes::CameraControlInterface::set_zoom ( const uint32_t  new_zoom)

Set zoom value.

Current zoom setting.

Parameters
new_zoomnew zoom value

Definition at line 181 of file CameraControlInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by PanTiltSonyEviD100PThread::update_sensor_values().

◆ set_zoom_max()

void fawkes::CameraControlInterface::set_zoom_max ( const uint32_t  new_zoom_max)

Set zoom_max value.

Maximum zoom value

Parameters
new_zoom_maxnew zoom_max value

Definition at line 243 of file CameraControlInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by PanTiltSonyEviD100PThread::init().

◆ set_zoom_min()

void fawkes::CameraControlInterface::set_zoom_min ( const uint32_t  new_zoom_min)

Set zoom_min value.

Minimum zoom

Parameters
new_zoom_minnew zoom_min value

Definition at line 274 of file CameraControlInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by PanTiltSonyEviD100PThread::init().

◆ set_zoom_supported()

void fawkes::CameraControlInterface::set_zoom_supported ( const bool  new_zoom_supported)

Set zoom_supported value.

Is zooming supported?

Parameters
new_zoom_supportednew zoom_supported value

Definition at line 212 of file CameraControlInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by PanTiltSonyEviD100PThread::init().

◆ tostring_Effect()

const char * fawkes::CameraControlInterface::tostring_Effect ( Effect  value) const

Convert Effect constant to string.

Parameters
valuevalue to convert to string
Returns
constant value as string.

Definition at line 82 of file CameraControlInterface.cpp.

◆ zoom()

uint32_t fawkes::CameraControlInterface::zoom ( ) const

Get zoom value.

Current zoom setting.

Returns
zoom value

Definition at line 161 of file CameraControlInterface.cpp.

Referenced by PanTiltSonyEviD100PThread::update_sensor_values().

◆ zoom_max()

uint32_t fawkes::CameraControlInterface::zoom_max ( ) const

Get zoom_max value.

Maximum zoom value

Returns
zoom_max value

Definition at line 223 of file CameraControlInterface.cpp.

◆ zoom_min()

uint32_t fawkes::CameraControlInterface::zoom_min ( ) const

Get zoom_min value.

Minimum zoom

Returns
zoom_min value

Definition at line 254 of file CameraControlInterface.cpp.


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