Fawkes API  Fawkes Development Version
fawkes::PanTiltInterface Class Reference

PanTiltInterface Fawkes BlackBoard Interface. More...

#include <>>

Inheritance diagram for fawkes::PanTiltInterface:

Classes

class  CalibrateMessage
 CalibrateMessage Fawkes BlackBoard Interface Message. More...
 
class  FlushMessage
 FlushMessage Fawkes BlackBoard Interface Message. More...
 
class  GotoMessage
 GotoMessage Fawkes BlackBoard Interface Message. More...
 
class  ParkMessage
 ParkMessage Fawkes BlackBoard Interface Message. More...
 
class  SetEnabledMessage
 SetEnabledMessage Fawkes BlackBoard Interface Message. More...
 
class  SetMarginMessage
 SetMarginMessage Fawkes BlackBoard Interface Message. More...
 
class  SetVelocityMessage
 SetVelocityMessage Fawkes BlackBoard Interface Message. More...
 
class  StopMessage
 StopMessage Fawkes BlackBoard Interface Message. More...
 
class  TimedGotoMessage
 TimedGotoMessage Fawkes BlackBoard Interface Message. More...
 

Public Member Functions

virtual bool message_valid (const Message *message) const
 Check if message is valid and can be enqueued. More...
 
uint32_t flags () const
 Get flags value. More...
 
void set_flags (const uint32_t new_flags)
 Set flags value. More...
 
size_t maxlenof_flags () const
 Get maximum length of flags value. More...
 
float pan () const
 Get pan value. More...
 
void set_pan (const float new_pan)
 Set pan value. More...
 
size_t maxlenof_pan () const
 Get maximum length of pan value. More...
 
float tilt () const
 Get tilt value. More...
 
void set_tilt (const float new_tilt)
 Set tilt value. More...
 
size_t maxlenof_tilt () const
 Get maximum length of tilt value. More...
 
uint32_t msgid () const
 Get msgid value. More...
 
void set_msgid (const uint32_t new_msgid)
 Set msgid value. More...
 
size_t maxlenof_msgid () const
 Get maximum length of msgid value. More...
 
bool is_final () const
 Get final value. More...
 
void set_final (const bool new_final)
 Set final value. More...
 
size_t maxlenof_final () const
 Get maximum length of final value. More...
 
uint32_t error_code () const
 Get error_code value. More...
 
void set_error_code (const uint32_t new_error_code)
 Set error_code value. More...
 
size_t maxlenof_error_code () const
 Get maximum length of error_code value. More...
 
bool is_enabled () const
 Get enabled value. More...
 
void set_enabled (const bool new_enabled)
 Set enabled value. More...
 
size_t maxlenof_enabled () const
 Get maximum length of enabled value. More...
 
bool is_calibrated () const
 Get calibrated value. More...
 
void set_calibrated (const bool new_calibrated)
 Set calibrated value. More...
 
size_t maxlenof_calibrated () const
 Get maximum length of calibrated value. More...
 
float min_pan () const
 Get min_pan value. More...
 
void set_min_pan (const float new_min_pan)
 Set min_pan value. More...
 
size_t maxlenof_min_pan () const
 Get maximum length of min_pan value. More...
 
float max_pan () const
 Get max_pan value. More...
 
void set_max_pan (const float new_max_pan)
 Set max_pan value. More...
 
size_t maxlenof_max_pan () const
 Get maximum length of max_pan value. More...
 
float min_tilt () const
 Get min_tilt value. More...
 
void set_min_tilt (const float new_min_tilt)
 Set min_tilt value. More...
 
size_t maxlenof_min_tilt () const
 Get maximum length of min_tilt value. More...
 
float max_tilt () const
 Get max_tilt value. More...
 
void set_max_tilt (const float new_max_tilt)
 Set max_tilt value. More...
 
size_t maxlenof_max_tilt () const
 Get maximum length of max_tilt value. More...
 
float max_pan_velocity () const
 Get max_pan_velocity value. More...
 
void set_max_pan_velocity (const float new_max_pan_velocity)
 Set max_pan_velocity value. More...
 
size_t maxlenof_max_pan_velocity () const
 Get maximum length of max_pan_velocity value. More...
 
float max_tilt_velocity () const
 Get max_tilt_velocity value. More...
 
void set_max_tilt_velocity (const float new_max_tilt_velocity)
 Set max_tilt_velocity value. More...
 
size_t maxlenof_max_tilt_velocity () const
 Get maximum length of max_tilt_velocity value. More...
 
float pan_velocity () const
 Get pan_velocity value. More...
 
void set_pan_velocity (const float new_pan_velocity)
 Set pan_velocity value. More...
 
size_t maxlenof_pan_velocity () const
 Get maximum length of pan_velocity value. More...
 
float tilt_velocity () const
 Get tilt_velocity value. More...
 
void set_tilt_velocity (const float new_tilt_velocity)
 Set tilt_velocity value. More...
 
size_t maxlenof_tilt_velocity () const
 Get maximum length of tilt_velocity value. More...
 
float pan_margin () const
 Get pan_margin value. More...
 
void set_pan_margin (const float new_pan_margin)
 Set pan_margin value. More...
 
size_t maxlenof_pan_margin () const
 Get maximum length of pan_margin value. More...
 
float tilt_margin () const
 Get tilt_margin value. More...
 
void set_tilt_margin (const float new_tilt_margin)
 Set tilt_margin value. More...
 
size_t maxlenof_tilt_margin () const
 Get maximum length of tilt_margin 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...
 

Static Public Attributes

static const uint32_t FLAG_SUPPORTS_PAN = 1u
 FLAG_SUPPORTS_PAN constant. More...
 
static const uint32_t FLAG_SUPPORTS_TILT = 2u
 FLAG_SUPPORTS_TILT constant. More...
 
static const uint32_t ERROR_NONE = 0u
 ERROR_NONE constant. More...
 
static const uint32_t ERROR_UNSPECIFIC = 1u
 ERROR_UNSPECIFIC constant. More...
 
static const uint32_t ERROR_COMMUNICATION = 2u
 ERROR_COMMUNICATION constant. More...
 
static const uint32_t ERROR_PAN_OUTOFRANGE = 4u
 ERROR_PAN_OUTOFRANGE constant. More...
 
static const uint32_t ERROR_TILT_OUTOFRANGE = 8u
 ERROR_TILT_OUTOFRANGE constant. 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

PanTiltInterface Fawkes BlackBoard Interface.

Interface to access pan/tilt units.

Definition at line 33 of file PanTiltInterface.h.

Member Function Documentation

◆ copy_values()

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

Copy values from other interface.

Parameters
otherother interface to copy values from

Implements fawkes::Interface.

Definition at line 707 of file PanTiltInterface.cpp.

References fawkes::Interface::type().

◆ create_message()

Message * fawkes::PanTiltInterface::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 676 of file PanTiltInterface.cpp.

◆ enum_tostring()

const char * fawkes::PanTiltInterface::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 718 of file PanTiltInterface.cpp.

◆ error_code()

uint32_t fawkes::PanTiltInterface::error_code ( ) const

Get error_code value.

Failure code set if final is true. 0 if no error occured, an error code from ERROR_* constants otherwise (or a bit-wise combination).

Returns
error_code value

Definition at line 270 of file PanTiltInterface.cpp.

◆ flags()

uint32_t fawkes::PanTiltInterface::flags ( ) const

Get flags value.

Flags.

Returns
flags value

Definition at line 109 of file PanTiltInterface.cpp.

◆ is_calibrated()

bool fawkes::PanTiltInterface::is_calibrated ( ) const

Get calibrated value.

Is the pan/tilt unit calibrated?

Returns
calibrated value

Definition at line 334 of file PanTiltInterface.cpp.

◆ is_enabled()

bool fawkes::PanTiltInterface::is_enabled ( ) const

Get enabled value.

Is the pan/tilt unit enabled?

Returns
enabled value

Definition at line 303 of file PanTiltInterface.cpp.

◆ is_final()

bool fawkes::PanTiltInterface::is_final ( ) const

Get final value.

True, if the last goto command has been finished, false if it is still running

Returns
final value

Definition at line 236 of file PanTiltInterface.cpp.

◆ max_pan()

float fawkes::PanTiltInterface::max_pan ( ) const

Get max_pan value.

Maximum pan possible.

Returns
max_pan value

Definition at line 396 of file PanTiltInterface.cpp.

◆ max_pan_velocity()

float fawkes::PanTiltInterface::max_pan_velocity ( ) const

Get max_pan_velocity value.

Maximum supported pan velocity.

Returns
max_pan_velocity value

Definition at line 489 of file PanTiltInterface.cpp.

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

◆ max_tilt()

float fawkes::PanTiltInterface::max_tilt ( ) const

Get max_tilt value.

Maximum tilt possible.

Returns
max_tilt value

Definition at line 458 of file PanTiltInterface.cpp.

◆ max_tilt_velocity()

float fawkes::PanTiltInterface::max_tilt_velocity ( ) const

Get max_tilt_velocity value.

Maximum supported tilt velocity.

Returns
max_tilt_velocity value

Definition at line 520 of file PanTiltInterface.cpp.

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

◆ maxlenof_calibrated()

size_t fawkes::PanTiltInterface::maxlenof_calibrated ( ) const

Get maximum length of calibrated value.

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

Definition at line 344 of file PanTiltInterface.cpp.

◆ maxlenof_enabled()

size_t fawkes::PanTiltInterface::maxlenof_enabled ( ) const

Get maximum length of enabled value.

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

Definition at line 313 of file PanTiltInterface.cpp.

◆ maxlenof_error_code()

size_t fawkes::PanTiltInterface::maxlenof_error_code ( ) const

Get maximum length of error_code value.

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

Definition at line 280 of file PanTiltInterface.cpp.

◆ maxlenof_final()

size_t fawkes::PanTiltInterface::maxlenof_final ( ) const

Get maximum length of final value.

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

Definition at line 246 of file PanTiltInterface.cpp.

◆ maxlenof_flags()

size_t fawkes::PanTiltInterface::maxlenof_flags ( ) const

Get maximum length of flags value.

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

Definition at line 119 of file PanTiltInterface.cpp.

◆ maxlenof_max_pan()

size_t fawkes::PanTiltInterface::maxlenof_max_pan ( ) const

Get maximum length of max_pan value.

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

Definition at line 406 of file PanTiltInterface.cpp.

◆ maxlenof_max_pan_velocity()

size_t fawkes::PanTiltInterface::maxlenof_max_pan_velocity ( ) const

Get maximum length of max_pan_velocity value.

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

Definition at line 499 of file PanTiltInterface.cpp.

◆ maxlenof_max_tilt()

size_t fawkes::PanTiltInterface::maxlenof_max_tilt ( ) const

Get maximum length of max_tilt value.

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

Definition at line 468 of file PanTiltInterface.cpp.

◆ maxlenof_max_tilt_velocity()

size_t fawkes::PanTiltInterface::maxlenof_max_tilt_velocity ( ) const

Get maximum length of max_tilt_velocity value.

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

Definition at line 530 of file PanTiltInterface.cpp.

◆ maxlenof_min_pan()

size_t fawkes::PanTiltInterface::maxlenof_min_pan ( ) const

Get maximum length of min_pan value.

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

Definition at line 375 of file PanTiltInterface.cpp.

◆ maxlenof_min_tilt()

size_t fawkes::PanTiltInterface::maxlenof_min_tilt ( ) const

Get maximum length of min_tilt value.

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

Definition at line 437 of file PanTiltInterface.cpp.

◆ maxlenof_msgid()

size_t fawkes::PanTiltInterface::maxlenof_msgid ( ) const

Get maximum length of msgid value.

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

Definition at line 213 of file PanTiltInterface.cpp.

◆ maxlenof_pan()

size_t fawkes::PanTiltInterface::maxlenof_pan ( ) const

Get maximum length of pan value.

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

Definition at line 150 of file PanTiltInterface.cpp.

◆ maxlenof_pan_margin()

size_t fawkes::PanTiltInterface::maxlenof_pan_margin ( ) const

Get maximum length of pan_margin value.

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

Definition at line 624 of file PanTiltInterface.cpp.

◆ maxlenof_pan_velocity()

size_t fawkes::PanTiltInterface::maxlenof_pan_velocity ( ) const

Get maximum length of pan_velocity value.

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

Definition at line 561 of file PanTiltInterface.cpp.

◆ maxlenof_tilt()

size_t fawkes::PanTiltInterface::maxlenof_tilt ( ) const

Get maximum length of tilt value.

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

Definition at line 181 of file PanTiltInterface.cpp.

◆ maxlenof_tilt_margin()

size_t fawkes::PanTiltInterface::maxlenof_tilt_margin ( ) const

Get maximum length of tilt_margin value.

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

Definition at line 657 of file PanTiltInterface.cpp.

◆ maxlenof_tilt_velocity()

size_t fawkes::PanTiltInterface::maxlenof_tilt_velocity ( ) const

Get maximum length of tilt_velocity value.

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

Definition at line 592 of file PanTiltInterface.cpp.

◆ message_valid()

bool fawkes::PanTiltInterface::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 1539 of file PanTiltInterface.cpp.

◆ min_pan()

float fawkes::PanTiltInterface::min_pan ( ) const

Get min_pan value.

Minimum pan possible.

Returns
min_pan value

Definition at line 365 of file PanTiltInterface.cpp.

◆ min_tilt()

float fawkes::PanTiltInterface::min_tilt ( ) const

Get min_tilt value.

Minimum tilt possible.

Returns
min_tilt value

Definition at line 427 of file PanTiltInterface.cpp.

◆ msgid()

uint32_t fawkes::PanTiltInterface::msgid ( ) const

Get msgid value.

The ID of the message that is currently being processed, or 0 if no message is being processed.

Returns
msgid value

Definition at line 203 of file PanTiltInterface.cpp.

◆ pan()

float fawkes::PanTiltInterface::pan ( ) const

Get pan value.

Current pan.

Returns
pan value

Definition at line 140 of file PanTiltInterface.cpp.

Referenced by WebviewPtzCamThread::loop().

◆ pan_margin()

float fawkes::PanTiltInterface::pan_margin ( ) const

Get pan_margin value.

Margin in radians around a target pan value to consider the motion as final.

Returns
pan_margin value

Definition at line 614 of file PanTiltInterface.cpp.

◆ pan_velocity()

float fawkes::PanTiltInterface::pan_velocity ( ) const

Get pan_velocity value.

Maximum pan velocity currently reached.

Returns
pan_velocity value

Definition at line 551 of file PanTiltInterface.cpp.

◆ set_calibrated()

void fawkes::PanTiltInterface::set_calibrated ( const bool  new_calibrated)

Set calibrated value.

Is the pan/tilt unit calibrated?

Parameters
new_calibratednew calibrated value

Definition at line 354 of file PanTiltInterface.cpp.

Referenced by PanTiltDirectedPerceptionThread::init(), PanTiltSonyEviD100PThread::init(), and PanTiltRX28Thread::init().

◆ set_enabled()

void fawkes::PanTiltInterface::set_enabled ( const bool  new_enabled)

Set enabled value.

Is the pan/tilt unit enabled?

Parameters
new_enablednew enabled value

Definition at line 323 of file PanTiltInterface.cpp.

Referenced by PanTiltDirectedPerceptionThread::init(), PanTiltSonyEviD100PThread::init(), and PanTiltRX28Thread::update_sensor_values().

◆ set_error_code()

void fawkes::PanTiltInterface::set_error_code ( const uint32_t  new_error_code)

Set error_code value.

Failure code set if final is true. 0 if no error occured, an error code from ERROR_* constants otherwise (or a bit-wise combination).

Parameters
new_error_codenew error_code value

Definition at line 292 of file PanTiltInterface.cpp.

◆ set_final()

void fawkes::PanTiltInterface::set_final ( const bool  new_final)

Set final value.

True, if the last goto command has been finished, false if it is still running

Parameters
new_finalnew final value

Definition at line 257 of file PanTiltInterface.cpp.

Referenced by PanTiltDirectedPerceptionThread::loop(), PanTiltSonyEviD100PThread::loop(), PanTiltRX28Thread::loop(), PanTiltDirectedPerceptionThread::update_sensor_values(), PanTiltSonyEviD100PThread::update_sensor_values(), and PanTiltRX28Thread::update_sensor_values().

◆ set_flags()

void fawkes::PanTiltInterface::set_flags ( const uint32_t  new_flags)

Set flags value.

Flags.

Parameters
new_flagsnew flags value

Definition at line 129 of file PanTiltInterface.cpp.

◆ set_max_pan()

void fawkes::PanTiltInterface::set_max_pan ( const float  new_max_pan)

Set max_pan value.

Maximum pan possible.

Parameters
new_max_pannew max_pan value

Definition at line 416 of file PanTiltInterface.cpp.

Referenced by PanTiltDirectedPerceptionThread::init(), PanTiltSonyEviD100PThread::init(), and PanTiltRX28Thread::init().

◆ set_max_pan_velocity()

void fawkes::PanTiltInterface::set_max_pan_velocity ( const float  new_max_pan_velocity)

Set max_pan_velocity value.

Maximum supported pan velocity.

Parameters
new_max_pan_velocitynew max_pan_velocity value

Definition at line 509 of file PanTiltInterface.cpp.

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

◆ set_max_tilt()

void fawkes::PanTiltInterface::set_max_tilt ( const float  new_max_tilt)

Set max_tilt value.

Maximum tilt possible.

Parameters
new_max_tiltnew max_tilt value

Definition at line 478 of file PanTiltInterface.cpp.

Referenced by PanTiltDirectedPerceptionThread::init(), PanTiltSonyEviD100PThread::init(), and PanTiltRX28Thread::init().

◆ set_max_tilt_velocity()

void fawkes::PanTiltInterface::set_max_tilt_velocity ( const float  new_max_tilt_velocity)

Set max_tilt_velocity value.

Maximum supported tilt velocity.

Parameters
new_max_tilt_velocitynew max_tilt_velocity value

Definition at line 540 of file PanTiltInterface.cpp.

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

◆ set_min_pan()

void fawkes::PanTiltInterface::set_min_pan ( const float  new_min_pan)

Set min_pan value.

Minimum pan possible.

Parameters
new_min_pannew min_pan value

Definition at line 385 of file PanTiltInterface.cpp.

Referenced by PanTiltDirectedPerceptionThread::init(), PanTiltSonyEviD100PThread::init(), and PanTiltRX28Thread::init().

◆ set_min_tilt()

void fawkes::PanTiltInterface::set_min_tilt ( const float  new_min_tilt)

Set min_tilt value.

Minimum tilt possible.

Parameters
new_min_tiltnew min_tilt value

Definition at line 447 of file PanTiltInterface.cpp.

Referenced by PanTiltDirectedPerceptionThread::init(), PanTiltSonyEviD100PThread::init(), and PanTiltRX28Thread::init().

◆ set_msgid()

void fawkes::PanTiltInterface::set_msgid ( const uint32_t  new_msgid)

Set msgid value.

The ID of the message that is currently being processed, or 0 if no message is being processed.

Parameters
new_msgidnew msgid value

Definition at line 224 of file PanTiltInterface.cpp.

Referenced by PanTiltDirectedPerceptionThread::loop(), PanTiltSonyEviD100PThread::loop(), and PanTiltRX28Thread::loop().

◆ set_pan()

void fawkes::PanTiltInterface::set_pan ( const float  new_pan)

Set pan value.

Current pan.

Parameters
new_pannew pan value

Definition at line 160 of file PanTiltInterface.cpp.

Referenced by PanTiltDirectedPerceptionThread::update_sensor_values(), PanTiltSonyEviD100PThread::update_sensor_values(), and PanTiltRX28Thread::update_sensor_values().

◆ set_pan_margin()

void fawkes::PanTiltInterface::set_pan_margin ( const float  new_pan_margin)

Set pan_margin value.

Margin in radians around a target pan value to consider the motion as final.

Parameters
new_pan_marginnew pan_margin value

Definition at line 635 of file PanTiltInterface.cpp.

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

◆ set_pan_velocity()

void fawkes::PanTiltInterface::set_pan_velocity ( const float  new_pan_velocity)

Set pan_velocity value.

Maximum pan velocity currently reached.

Parameters
new_pan_velocitynew pan_velocity value

Definition at line 571 of file PanTiltInterface.cpp.

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

◆ set_tilt()

void fawkes::PanTiltInterface::set_tilt ( const float  new_tilt)

Set tilt value.

Current tilt.

Parameters
new_tiltnew tilt value

Definition at line 191 of file PanTiltInterface.cpp.

Referenced by PanTiltDirectedPerceptionThread::update_sensor_values(), PanTiltSonyEviD100PThread::update_sensor_values(), and PanTiltRX28Thread::update_sensor_values().

◆ set_tilt_margin()

void fawkes::PanTiltInterface::set_tilt_margin ( const float  new_tilt_margin)

Set tilt_margin value.

Margin in radians around a target tilt value to consider the motion as final.

Parameters
new_tilt_marginnew tilt_margin value

Definition at line 668 of file PanTiltInterface.cpp.

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

◆ set_tilt_velocity()

void fawkes::PanTiltInterface::set_tilt_velocity ( const float  new_tilt_velocity)

Set tilt_velocity value.

Maximum tilt velocity currently reached.

Parameters
new_tilt_velocitynew tilt_velocity value

Definition at line 602 of file PanTiltInterface.cpp.

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

◆ tilt()

float fawkes::PanTiltInterface::tilt ( ) const

Get tilt value.

Current tilt.

Returns
tilt value

Definition at line 171 of file PanTiltInterface.cpp.

Referenced by WebviewPtzCamThread::loop().

◆ tilt_margin()

float fawkes::PanTiltInterface::tilt_margin ( ) const

Get tilt_margin value.

Margin in radians around a target tilt value to consider the motion as final.

Returns
tilt_margin value

Definition at line 647 of file PanTiltInterface.cpp.

◆ tilt_velocity()

float fawkes::PanTiltInterface::tilt_velocity ( ) const

Get tilt_velocity value.

Maximum tilt velocity currently reached.

Returns
tilt_velocity value

Definition at line 582 of file PanTiltInterface.cpp.

Member Data Documentation

◆ ERROR_COMMUNICATION

const uint32_t fawkes::PanTiltInterface::ERROR_COMMUNICATION = 2u
static

ERROR_COMMUNICATION constant.

Definition at line 44 of file PanTiltInterface.h.

◆ ERROR_NONE

const uint32_t fawkes::PanTiltInterface::ERROR_NONE = 0u
static

ERROR_NONE constant.

Definition at line 42 of file PanTiltInterface.h.

◆ ERROR_PAN_OUTOFRANGE

const uint32_t fawkes::PanTiltInterface::ERROR_PAN_OUTOFRANGE = 4u
static

ERROR_PAN_OUTOFRANGE constant.

Definition at line 45 of file PanTiltInterface.h.

◆ ERROR_TILT_OUTOFRANGE

const uint32_t fawkes::PanTiltInterface::ERROR_TILT_OUTOFRANGE = 8u
static

ERROR_TILT_OUTOFRANGE constant.

Definition at line 46 of file PanTiltInterface.h.

◆ ERROR_UNSPECIFIC

const uint32_t fawkes::PanTiltInterface::ERROR_UNSPECIFIC = 1u
static

ERROR_UNSPECIFIC constant.

Definition at line 43 of file PanTiltInterface.h.

◆ FLAG_SUPPORTS_PAN

const uint32_t fawkes::PanTiltInterface::FLAG_SUPPORTS_PAN = 1u
static

FLAG_SUPPORTS_PAN constant.

Definition at line 40 of file PanTiltInterface.h.

◆ FLAG_SUPPORTS_TILT

const uint32_t fawkes::PanTiltInterface::FLAG_SUPPORTS_TILT = 2u
static

FLAG_SUPPORTS_TILT constant.

Definition at line 41 of file PanTiltInterface.h.


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