orca-robotics INTRODUCTION Overview Download and Install Quick Start Documentation Publications REPOSITORY Interfaces Components Libraries Utilities Software Map DEVELOPER Tutorials Examples Dev Guide Dashboard Wiki login/pass: orca/orca PEOPLE Contributors Users Project Download Mailing lists

Orca Robotics Class List Here are the classes, structs, unions and interfaces with brief descriptions: orcaicegrid::AbstractIceGridManager Creates and maintains an IceGrid admin session orcaice::Activator A 'fire-and-forget' component activator orca::AngularAcceleration 3D angular acceleration orca::AngularVelocity 3D angular velocity orcaice::Application Similar to Ice::Application, plus some Orca-specifc stuff orcalog::AutoLogger An AutoLogger simply logs continuously once it's started orcalog::AutoLoggerFactory Factory of AutoLogger instances orca::BatteryData orca::BinaryDeviceData orca::BinaryIndicator Interface to a device with a binary state orca::BinarySwitch Interface to a device with a binary state orca::BinarySwitchData Information about the binary devices of a robot orcaqgui2d::BoxElement Draws a simple square on the map orcaifaceimpl::BufferedConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType > orca::BusyException Raised when the component is too busy to process requests orca::Button Interface to a device with a binary state orcaqgui2d::ButtonElement orcaifaceimpl::ButtonImpl orca::Camera Interface to the camera orca::CameraConsumer orca::CameraData orca::CameraDescription Camera configuration objectd orcaifaceimpl::CameraImpl orca::CartesianAcceleration 3D acceleration in Cartesian coordinate system orca::CartesianAcceleration2d 2D acceleration in Cartesian coordinate system orca::CartesianLineFeature2d orca::CartesianPoint 3D position in Cartesian coordinate system orca::CartesianPoint2d 2D position in Cartesian coordinate system orca::CartesianPointFeature2d A basic x-y point feature orca::CartesianPoseFeature2d A point feature with a heading orca::CartesianVector 3D vector orca::CartesianVelocity 3D velocity in Cartesian coordinate system orca::CartesianVelocity2d 2D velocity in Cartesian coordinate system orcaquml::Component UML Component element orcaice::Component Base class for all Components using libOrcaIce orcadef::ComponentCfg Holds the information for component configuration orca::ComponentData Component data orcacm::ComponentData orcaice::ComponentDeactivatingException orcadef::ComponentDef Holds the information for component definition orcaquml::ComponentGeom On-screen geometry of a component. Used to save and reload on-screen configuration orcacm::ComponentHeader orcaquml::ComponentModel A class to hold all relevant component information orcadef::ConfigCfg Configuration option orcadef::ConfigDef Definition of a configuration option orcaice::ConfigFileException This exception is raised when something goes wrong while reading the configuration file orca::ConfigurationNotExistException Server failed to configure itself as requrested by client orcaifaceimpl::ConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType > orcaifaceimpl::ConsumerSubscriber orcaice::Context Component's naming and networking information orca::Covariance2d orca::Covariance3d orca::Cpu Interface to CPU information orca::CpuConsumer Subscriber to CPU information orca::CpuData Current CPU information orca::CpuInfo General CPU information orca::DataNotExistException orca::Date Date of the year orcaqgui2d::DefaultFactory orcaqgui3d::DefaultFactory orca::DiscreteSize2d Planar discrete dimensions orca::DiscreteSize3d Spatial discrete dimensions orca::DriveBicycle orca::DriveBicycleCommand Bicycle command: steering angle & velocity orca::DriveBicycleConsumer Data consumer interface orca::DriveBicycleData Bicycle data: commanded and actual steering angle & velocity orcaifaceimpl::DriveBicycleImpl orca::DriveDifferential orca::DriveDifferentialData Differential steering velocity command orca::DriveDifferentialDescription Description of differential steering mechanism orcalog::DummyReplayer This one can be used for unsupported or disabled interfaces orca::EStop Interface to e-stop orca::EStopAlreadyTriggeredException Raised when a keep-alive is sent to an estop-disabled platform orca::EStopData orcaifaceimpl::EStopImpl orcaifaceimpl::EStopNonStandardImpl EStopImpl needs a pointer to a class implementing these orcalog::Exception Base class for exceptions coming from libOrcaLog orcadef::Exception Base class for exceptions coming from libOrcaDef orcalog::Factory orcaprobe::Factory orca::Feature2d Generic 2D feature orca::FeatureMap2d An interface to a map of features orca::FeatureMap2dConsumer Consumer of FeatureMap2d data orca::FeatureMap2dData Data describing generic 2D features orcaqgui2d::FeatureMap2dElement orcaifaceimpl::FeatureMap2dImpl orcalog::FileException Raised when something is wrong with reading the definition file orcadef::FileException Throw it when something is wrong with reading the definition file orca::Force Vector representing a linear force orca::Force2d Vector representing a linear force orcalog::FormatNotSupportedException Raised when a format is specified which the slave logger does not support orca::FQComponentName Fully qualified component name orca::FQExecutableName Fully qualified executable name orca::FQInterfaceName Fully qualified interface name. Usually represented in a single string as 'iface@platform/component' orca::FQTopicName Fully qualified Ice Storm topic name. The idea is that the same interface can publish to multiple topics corresponding different data streams. When written as a string, this is formatted as: interface/topicName/component orca::Frame2d Planar position orca::Frame3d Spatial position orcalogfactory::GenericAutoLogger< DataType, ConsumerType, ConsumerPrxType, PrxType, LogWriterType > orcalogfactory::GenericSnapshotLogger< DataType, ConsumerType, ConsumerPrxType, PrxType, LogWriterType > orcaqcm::GetComponentsJob orca::Gps Access to GpsData (raw data) orca::GpsConsumer orca::GpsData Gps data structure orca::GpsDescription Gps config structure orcaifaceimpl::GpsImpl orcaqgui2d::GridElement Paints a rectangular grid in the display orcaqgui3d::GridElement Paints a rectangular grid in the 3d display orcaqgui3d::GuiElement3d orcaqgemv::GuiElementModel Stores the set of GuiElements orca::HandConfig Laser configuration data structure orca::HandConsumer Consumer of laser scans orca::HandData orca::HandProducer Single-origin scanning range sensor orca::HardwareFailedException Indicates a problem with robot hardware, e.g. sensors and actuators orcaice::Heartbeater Small utility class for keeping track of regular heartbeats orcaice::Home Local API to component information orca::Home Access to information about components interfaces orca::HomeData Contains data on the component's interfaces orcacm::HomeHeader Information about a Home object orcaicegrid::IceGridManager Wraps up functions remotely controlling an IceGrid Registry orcaicegrid::IceGridSession Creates and maintains an IceGrid admin session orcaqguielementutil::IceStormElement< PainterType, DataType, ProxyType, ConsumerType, ConsumerPrxType > Base class for gui elements that receive data from IceStorm orcaqgui3d::IceStormElement3d< PainterType, DataType, ProxyType, ConsumerType, ConsumerPrxType > Base class for gui elements that receive data from IceStorm orcaqguielementutil::IceStormListener< DataType, ProxyType, ConsumerType, ConsumerPrxType, SubscriptionMakerType, UnSubscriptionMakerType > Listens to IceStorm and stores the incoming data orcaqgui::IGuiElementFactory Simply allows for orcaice::Context to be set orcaqgui3d::IKnowsPlatformPosition orca::Image Interface to the image provider orca::ImageConsumer Interface to the image consumer orca::ImageData A single image orca::ImageDescription Static description of the image source orcaifaceimpl::ImageImpl orca::Imu Access to IMU data orca::ImuConsumer orca::ImuData orca::ImuDescription Imu configuration objectd orcaifaceimpl::ImuImpl orca::Ins Access to INS data orca::InsConsumer orca::InsData orca::InsDescription Ins configuration objectd orcaifaceimpl::InsImpl orcadef::InterfaceCfg Configuration of an interface orcacm::InterfaceData orcadef::InterfaceDef Definition of an interface orca::LaserScanner2d Single-origin scanning range sensor orca::LaserScanner2dData Laser scan data structure adds return-intensity information to rangescanner data orcaqgui3d::LaserScanner2dElement 3d laser element orcaifaceimpl::LaserScanner2dImpl orcaqgui3d::LaserScanner2dPainter LaserPainter paints laser scans orcaqgui2d::LaserScanner2dPainter Paints laser scans orca::util::LatencyPinger Test component which initiates timed transmission orca::util::LatencyReplier Test component which replies to timed transmission orca::LinePolarFeature2d orca::Localise2d Access to odometry of 2d mobile robitic bases orca::Localise2dConsumer orca::Localise2dData Location estimate orcaifaceimpl::Localise2dImpl orca::Localise3d Access pose of 3d mobile robotic bases orca::Localise3dConsumer orca::Localise3dData Localise3d data structure orcaifaceimpl::Localise3dImpl orca::Log Interface to the loggiing process orca::LogData Information about the status of the logging process orcalog::LogReader orcalog::LogReaderInfo orcalog::LogWriter Base class for all interface slaves Sets up a data file and registers with the MasterFileWriter. The individual log writers (e.g. LaserLogWriter) inherit from this class orcalog::LogWriterInfo orcaqgui::MainWindow orcaqgui::MainWindow::ScreenDumpParams Configuration parameters for screen capture orca::MalformedParametersException Raised when one or more parameters to a remote request were malformed orcalog::MasterFileReader Knows how to parse a master file orcalog::MasterFileWriteHandler orcalog::MasterFileWriter Maintains the master file orcalog::MasterFileWriteThread orca::Moment Moment of force orcaice::NetworkException This exception is raised when something is wrong with the network connection orcaifaceimpl::NotifyingConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType > orcaqgui3d::ObjectModel A 3-D model of an object, loaded from a .3ds model orcaqcm::OcmDelegate orcaqcm::OcmModel orcaqcm::OcmView orca::Odometry2d Access to odometry of 2d mobile robotic bases orca::Odometry2dConsumer Data consumer interface orca::Odometry2dData Odometry2d data structure orcaifaceimpl::Odometry2dImpl orcaqgui2d::Odometry2dPainter Odometry2DPainter is used for displaying the odometric velocities in the robotic platform frame orca::Odometry3d Access to odometry of mobile robotic bases orca::Odometry3dConsumer Data consumer interface orca::Odometry3dData Odometric data structure orcaifaceimpl::Odometry3dImpl orca::OgCellLikelihood A basic structure for individual likelihoods per cell orca::OgFusion orca::OgFusionConfig Description of the OgFusion interface orca::OgFusionData orca::OgMap Access to occupancy-grid map orca::OgMapConsumer orca::OgMapData Occupancy-grid representation of a portion of the world orcaifaceimpl::OgMapImpl orca::OGPatchMap orca::OGPatchMapConsumer laser2og::OgSensorModel orcacm::OperationData orcacm::OperationHeader orca::OperationNotImplementedException Raised when a remote operation is not implemented orca::OrcaException A generic run-time exception orca::OrcaObject Base class for data types in Orca orca::OrientationE Orientation defined by angles orcalog::ParseException Raised when something is wrong with parsing log file orcadef::ParseException Throw it when something is wrong in parsing the definition file orca::Particle2d Interface for a 2d particle-based localiser orca::Particle2dConsumer Consumer of 2d particles orca::Particle2dData orcaifaceimpl::Particle2dImpl orcaqgui2d::Particle2dPainter Particle2DPainter is used for displaying the particles from a Monte Carlo Localization component orca::PathFollower2d The Path Follower orca::PathFollower2dConsumer Consumer of path updates orca::PathFollower2dData orcaifaceimpl::PathFollower2dImpl localnav::PathFollowerInterface orca::PathPlanner2d Planning a path in 2D orca::PathPlanner2dConsumer Consumer of a planned path orca::PathPlanner2dData Data structure for resulting path including error codes orca::PathPlanner2dTask orca::Pinger An interface which provides the well-known ping service orca::PingException Thrown when something goes wrong orca::Pixel Represents a single pixel encoded as Red-Green-Blue intensities orca::PixMap Access to pixMap orca::PixMapConsumer orca::PixMapData Data for PixMap interface orcaifaceimpl::PixMapImpl orcaqgui2d::PixmapPainter orcaqgui3d::PlatformCSFinder Class to work out the coordinate-system of a platform. Applies a bunch of heuristics orcacm::PlatformData orcaqgui::PlatformFocusCombo A QCombo box allowing users to select the platform in focus orcacm::PlatformHeader orca::PointCloud Interface for a 3d point cloud orca::PointCloudConsumer Point cloud consumer orca::PointCloudData Point cloud data structure orca::PointCloudDescription Description of the point cloud orca::PointCovariance2d 2d Covariance Matrix orca::PointPolarFeature2d orca::PolarAcceleration2d 2D acceleration in polar coordinate system orca::PolarFeature2d Interface to features in a polar coordinate system orca::PolarFeature2dConsumer orca::PolarFeature2dData A single data transmission may include a sequence of 2D polar features orca::PolarFeature2dDescription Device description orcaifaceimpl::PolarFeature2dImpl orcaqgui2d::PolarFeature2dPainter PolarFeature2dPainter paints polar feature orca::PolarPoint2d 2D position in polar coordinate system orca::PolarVelocity2d 2D velocity in polar coordinate system orca::Pose2dHypothesis A Gaussian distribution over pose space orca::Pose3dHypothesis A Gaussian distribution over pose space orca::PosePolarFeature2d orcasim2d::PosePublisher Publishes pose information on an orca::Localise2d interface orcaice::PostActivationCallback A hook to allow something to be done post-activation orca::Power Access to a robot's power subsystem orca::PowerConsumer Interface to the consumer of power information orca::PowerData Information about the power subsystem of a robot orcaifaceimpl::PowerImpl orcaifaceimpl::PrintingConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType > A convenience class for consumers with setData() operation orca::Properties Interface to Properties information orca::PropertiesConsumer Subscriber to Properties information orca::PropertiesData Information about properties orcaifaceimpl::PropertiesImpl orcadef::ProvidedCfg Configuration of a provided interface orcadef::ProvidedDef Definition of a provided interface orca::ProvidedInterface Brief version of provided interface data orcacm::ProvidesHeader orcaice::PtrBuffer< Type > A thread-safe data pipe with buffer semantics for Ice smart pointers orcaqguielementutil::PtrIceStormElement< PainterType, DataType, DataPtrType, ProxyType, ConsumerType, ConsumerPrxType > Base class for gui elements that receive data from IceStorm orcaqgui3d::PtrIceStormElement3d< PainterType, DataType, DataPtrType, ProxyType, ConsumerType, ConsumerPrxType > Base class for gui elements that receive data from IceStorm orcaqguielementutil::PtrIceStormListener< DataType, DataPtrType, ProxyType, ConsumerType, ConsumerPrxType, SubscriptionMakerType, UnSubscriptionMakerType > Listens to IceStorm and stores the incoming data orcaice::PtrNotify< Type > A data pipe with callback semantics for Ice smart pointers orcaice::PtrStore< Type > Thread-safe storage for a single data object represented by an Ice smart pointer orca::Ptz Single-origin scanning range sensor orca::PtzConsumer Consumer of ptz updates orca::PtzData orca::PtzGeometry PTZ geometry data structure orca::QGraphics2d Access to the drawable entity orca::QGraphics2dConsumer orca::QGraphics2dData QGraphics2d command structure: tells how to paint something orcaifaceimpl::QGraphics2dImpl orcaqgui2d::QGraphics2dPainter QGraphics2dPainter orca::RangeScanner2d Single-origin scanning range sensor orca::RangeScanner2dConsumer Consumesrange scans orca::RangeScanner2dData orca::RangeScanner2dDescription Device description orcaifaceimpl::RangeScanner2dImpl orcasim2d::RangeScanPublisher Publishes range scans out an orca interface orcacm::RegistryFlatData Registry data which lists components orcacm::RegistryHierarchicalData1 Registry data which lists platforms orcacm::RegistryHierarchicalData2 Registry data which lists platforms orcacm::RegistryHomeData Registry data orcaqgemv::RegSelectView Shows the contents of the Registry, allows users to click on things to add them orca::Replay Interface to the log playing process orca::ReplayData Information about the status of the replay process orcalog::Replayer orcalog::ReplayerFactory Factory of log replayers orcadef::RequiredCfg Configuration of a required interface orcadef::RequiredDef Definition of a required interface orca::RequiredInterface Brief version of required interface data orca::RequiredInterfaceFailedException Raised when a component failed to connect to a required interface orcacm::RequiresHeader orcacm::ResultHeader Brief version of operation result orcaqgui::SelectableElementWidget orcaice::Service Base class to use when putting Orca components into an IceBox orcaicegrid::SessionNotConnectedException This exception is raised when the session is not connected orca::SingleParticle2d A single particle orca::SinglePolarFeature2d orca::Size2d Planar continuous dimensions orca::Size3d Spatial continuous dimensions orcalog::SnapshotLogBuffer< ObjectType, LogWriterType > A fixed-length (in time) circular buffer orcalog::SnapshotLogger orcalog::SnapshotLoggerFactory Factory of SnapshotLogger instances orcarobotdriverutil::StateMachine A thread-safe state machine useful when writing robot hardware drivers segwayrmp::Stats orca::Status Access to a robot's status subsystem orca::StatusConsumer orca::StatusData Component status data orcaifaceimpl::StoringConsumerImpl< ProviderPrxType, ConsumerType, ConsumerPrxType, ObjectType > orca::SubscriptionFailedException Raised when the server fails to subscribe client for periodic updates orca::SubsystemStatus Status for a single subsystem of this component orca::Time Unix absolute time orca::TimeOfDay orca::Tracer Routes different types of information to different destinations orca::TracerConsumer orca::TracerData Component status data orca::TracerVerbosityConfig Verbosity levels for different trace types orca::Twist2d Planar velocity orca::Twist3d Spatial velocity: ordered couple (V,W) of two vectors orcaice::TypeMismatchException This exception is raised if the required interface type does not match the proxy type orca::Vector2d 2D vector orca::VehicleControlDescription orca::VehicleControlVelocityBicycleDescription Static description of a Velocity-controlled Bicycle-Drive vehicle orca::VehicleControlVelocityDifferentialDescription Static description of a Velocity-controlled Differential-Drive vehicle orca::VehicleDescription General description of a robotic vehicle orca::VehicleGeometryCuboidDescription orca::VehicleGeometryCylindricalDescription orca::VehicleGeometryDescription orca::VelocityControl2d Sends velocity command to a 2D mobile robot orca::VelocityControl2dData Velocity command object orcaifaceimpl::VelocityControl2dImpl orca::Waypoint2d A single waypoint orca::Wifi Interface to Wifi information orca::WifiConsumer Subscriber to Wifi information orca::WifiData Wireless signal data orcaifaceimpl::WifiImpl orca::WifiInterface Contains information per wireless interface, e.g. eth1 orca::Wrench Spatial force: ordered couple (F,M) of two vectors orca::Wrench2d Planar force orcaicexml::XmlAttributesHelper This code is extracted from IceGrid

Webmaster: Tobias Kaupp (tobasco at users.sourceforge.net)

---