scl::SUIParsed Class Reference

#include <SUIParsed.hpp>

Inheritance diagram for scl::SUIParsed:

Collaboration diagram for scl::SUIParsed:

Classes
class	SUIHapticControl
class	SUIKeyboardControl
class	SUIWindow
class	SUIWindowGraphical

Public Types
enum	EKbdKeySpec {   KBD_KEY_swdaeq =0, KBD_KEY_kiljou =1, KBD_KEY_gthfyr =2, KBD_KEY_WSDAEQ =3,   KBD_KEY_KILJOU =4, KBD_KEY_GTHFYR =5 }

Public Member Functions
	SUIParsed ()
virtual const std::string &	getType () const
virtual const std::string &	getName () const
virtual bool	hasBeenInit () const

Public Attributes
sutil::CMappedList < std::string, SUIKeyboardControl >	ui_keyboard_key_sets_
sutil::CMappedList < std::string, SUIHapticControl >	ui_haptic_devices_
sutil::CMappedList < std::string, SUIWindow >	ui_windows_
sutil::CMappedList < std::string, SUIWindowGraphical >	ui_windows_graphical_
std::string	name_
sBool	has_been_init_

Protected Attributes
std::string	type_

Detailed Description

Contains all the static information for user interface settings.

Set input devices, ui-point attachments etc. here.

This class is intended to be read by an app, which can use the information to set up its interface.

Purpose : Provide spec => Can be used to attach ui objects to controllers etc.

Member Enumeration Documentation

enum scl::SUIParsed::EKbdKeySpec

An enum to specify the keyboard set used

Constructor & Destructor Documentation

scl::SUIParsed::SUIParsed ( )

inline

Constructor : Sets stuff to zero.

Member Function Documentation

virtual const std::string& scl::SObject::getName ( ) const

inlinevirtualinherited

Get the object's type

virtual const std::string& scl::SObject::getType ( ) const

inlinevirtualinherited

Get the object's type

virtual bool scl::SObject::hasBeenInit ( ) const

inlinevirtualinherited

Get the object's type

Member Data Documentation

sBool scl::SObject::has_been_init_

inherited

Whether the object is ready for use

std::string scl::SObject::name_

inherited

The object's name

std::string scl::SObject::type_

protectedinherited

The object's type. Should only be set by the constructor

sutil::CMappedList<std::string, SUIHapticControl> scl::SUIParsed::ui_haptic_devices_

Holds the information about how to connect any attached haptic devices to a robot

sutil::CMappedList<std::string, SUIKeyboardControl> scl::SUIParsed::ui_keyboard_key_sets_

Holds the information about the keyboard ui points from the xml file

sutil::CMappedList<std::string, SUIWindow> scl::SUIParsed::ui_windows_

Holds the information about any ui windows

sutil::CMappedList<std::string, SUIWindowGraphical> scl::SUIParsed::ui_windows_graphical_

Holds the information about any ui windows with graphics in them

---

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

• /home/samir/Code/control/scl.git/src/scl/data_structs/SUIParsed.hpp