RegionCam Class Reference
Forwards segmented images from camera over wireless. More...
#include <RegionCam.h>
Detailed Description
Forwards segmented images from camera over wireless.
Definition at line 14 of file RegionCam.h.
Public Member Functions | |
| RegionCam () | |
| constructor | |
| virtual void | doStart () |
| Delegate function for subclasses to be notified when the behavior starts up. | |
| virtual void | doStop () |
| Delegate function for subclasses to be notified when the behavior starts up. | |
| virtual void | doEvent () |
| Delegate function for event processing, the event itself is pointed to (only for the duration of the doEvent() call!) by event. | |
| virtual std::string | getDescription () const |
| Gives a short description of what this particular instantiation does (in case a more specific description is needed on an individual basis). | |
Static Public Member Functions | |
| static std::string | getClassDescription () |
| Gives a short description of what this class of behaviors does... you should override this (but don't have to). | |
Static Public Attributes | |
| static const unsigned int | TCP_WIRELESS_BUFFER_SIZE = 85000 |
| 85000 bytes for use up to 416x320 pixels / 8 min expected runs * 5 bytes per run + some padding | |
| static const unsigned int | UDP_WIRELESS_BUFFER_SIZE = 64*1024 |
| 64KB is the max udp packet size | |
Protected Member Functions | |
| void | closeServer () |
| tear down the server socket (visRegion) | |
| void | setupServer () |
| setup the server socket (visRegion) | |
| bool | openPacket (FilterBankGenerator &fbkgen, unsigned int time, unsigned int layer) |
| opens a new packet, writes header info; returns true if open, false if otherwise open (check cur==NULL for error) | |
| bool | writeRegions (const FilterBankEvent &fbke) |
| writes the region information | |
| void | closePacket () |
| closes and sends a packet, does nothing if no packet open | |
Protected Attributes | |
| Socket * | visRegion |
| socket to send image stream over | |
| char * | packet |
| buffer being filled out to be sent | |
| char * | cur |
| current location in packet | |
| unsigned int | avail |
| number of bytes remaining in packet | |
| unsigned int | max_buf |
| the buffer size requested from Wireless when the socket was allocated | |
Private Member Functions | |
| RegionCam (const RegionCam &) | |
| don't call | |
| RegionCam & | operator= (const RegionCam &) |
| don't call | |
Constructor & Destructor Documentation
| RegionCam::RegionCam | ( | ) |
constructor
Definition at line 16 of file RegionCam.cc.
| RegionCam::RegionCam | ( | const RegionCam & | ) | [private] |
don't call
Member Function Documentation
| void RegionCam::closePacket | ( | ) | [protected] |
closes and sends a packet, does nothing if no packet open
Definition at line 140 of file RegionCam.cc.
Referenced by writeRegions().
| void RegionCam::closeServer | ( | ) | [protected] |
tear down the server socket (visRegion)
Definition at line 56 of file RegionCam.cc.
| void RegionCam::doEvent | ( | ) | [virtual] |
Delegate function for event processing, the event itself is pointed to (only for the duration of the doEvent() call!) by event.
Default implementation watches for 'private' text message events (those forwarded by a BehaviorSwitchControl from ControllerGUI input) and will publically rebroadcast them. The idea is that your own processEvent gets first dibs, but if the behavior doesn't handle the text message, it will be handed off for others.
Reimplemented from BehaviorBase.
Definition at line 36 of file RegionCam.cc.
| void RegionCam::doStart | ( | ) | [virtual] |
Delegate function for subclasses to be notified when the behavior starts up.
Should be overridden by subclasses to subscribe to events, install motion commands, etc.
doStart() is basically a hook to allow subclasses to jump in and do some customization of behavior parameters while the behavior is starting. If you are writing a behavior class and do not expect further derivation, just override doStart() yourself. However, if you do expect further derivation of your class, consider using preStart() or postStart() instead, and leave doStart() for the 'leaf' classes.
Reimplemented from BehaviorBase.
Definition at line 22 of file RegionCam.cc.
| void RegionCam::doStop | ( | ) | [virtual] |
Delegate function for subclasses to be notified when the behavior starts up.
May be overridden to cleanup when the behavior is shutting down. However events will automatically be unsubscribed, and by using addMotion(), motions will automatically be removed by stop(), so you may not need any cleanup.
Reimplemented from BehaviorBase.
Definition at line 29 of file RegionCam.cc.
| static std::string RegionCam::getClassDescription | ( | ) | [static] |
Gives a short description of what this class of behaviors does... you should override this (but don't have to).
If you do override this, also consider overriding getDescription() to return it
Reimplemented from BehaviorBase.
Definition at line 28 of file RegionCam.h.
Referenced by getDescription().
| virtual std::string RegionCam::getDescription | ( | ) | const [virtual] |
Gives a short description of what this particular instantiation does (in case a more specific description is needed on an individual basis).
By default simply returns getName(), because any calls from a BehaviorBase function to getClassDescription() are going to call BehaviorBase::getClassDescription(), not ~YourSubClass~getClassDescription(), because static functions can't be virtual in C++ (doh!)
This means that getDescription called on a pointer to a BehaviorBase of unknown subtype would always return an empty string, which is pretty useless. So instead we return the name in this situation. If you want getDescription to return getClassDescription, you'll have to override it in your subclass to do so.
Reimplemented from BehaviorBase.
Definition at line 33 of file RegionCam.h.
| bool RegionCam::openPacket | ( | FilterBankGenerator & | fbkgen, | |
| unsigned int | time, | |||
| unsigned int | layer | |||
| ) | [protected] |
opens a new packet, writes header info; returns true if open, false if otherwise open (check cur==NULL for error)
see the class documentation for RegionCam for the protocol documentation
Definition at line 90 of file RegionCam.cc.
Referenced by writeRegions().
| void RegionCam::setupServer | ( | ) | [protected] |
setup the server socket (visRegion)
Definition at line 66 of file RegionCam.cc.
| bool RegionCam::writeRegions | ( | const FilterBankEvent & | fbke | ) | [protected] |
Member Data Documentation
unsigned int RegionCam::avail [protected] |
number of bytes remaining in packet
Definition at line 48 of file RegionCam.h.
Referenced by closePacket(), openPacket(), and writeRegions().
char* RegionCam::cur [protected] |
current location in packet
Definition at line 47 of file RegionCam.h.
Referenced by closePacket(), openPacket(), and writeRegions().
unsigned int RegionCam::max_buf [protected] |
the buffer size requested from Wireless when the socket was allocated
Definition at line 49 of file RegionCam.h.
Referenced by openPacket(), and setupServer().
char* RegionCam::packet [protected] |
buffer being filled out to be sent
Definition at line 46 of file RegionCam.h.
Referenced by closePacket(), and openPacket().
const unsigned int RegionCam::TCP_WIRELESS_BUFFER_SIZE = 85000 [static] |
85000 bytes for use up to 416x320 pixels / 8 min expected runs * 5 bytes per run + some padding
Definition at line 19 of file RegionCam.h.
Referenced by setupServer().
const unsigned int RegionCam::UDP_WIRELESS_BUFFER_SIZE = 64*1024 [static] |
64KB is the max udp packet size
Definition at line 20 of file RegionCam.h.
Referenced by setupServer().
Socket* RegionCam::visRegion [protected] |
socket to send image stream over
Definition at line 45 of file RegionCam.h.
Referenced by closePacket(), closeServer(), doEvent(), openPacket(), and setupServer().
The documentation for this class was generated from the following files:
