simth::DeviceDescription Class Reference

Device description from devicelist XML file. More...

#include <devicemanager.h>

List of all members.

Public Types
typedef std::vector< IfaceDescr >	IfaceList
Public Member Functions
	DeviceDescription ()
	DeviceDescription (const DeviceDescription &)
DeviceDescription &	operator= (const DeviceDescription &)
	~DeviceDescription ()
bool	operator== (const DeviceDescription &d) const
bool	operator< (const DeviceDescription &d) const
const std::string &	name () const
const std::string &	type () const
const std::string &	extends () const
const std::string &	type_escaped () const
unsigned	nr_input_interfaces () const
unsigned	nr_output_interfaces () const
const DeviceDescription::IfaceList &	input_interfaces () const
const DeviceDescription::IfaceList &	output_interfaces () const
const PropertyList &	properties () const
const Property::list_string &	libraries () const
bool	isAbstract () const
const std::string &	description () const
void	toStream (std::ostream &os) const
Static Public Member Functions
static std::string	typename_escape (const std::string &s)
static std::string	typename_unescape (const std::string &s)
Friends
class	DeviceManager
Classes
class	IfaceDescr

---

Detailed Description

Device description from devicelist XML file.

This class is a direct representation of a device description in a devicelist XML file. The data here is directly the data that was specified in the devicelist.dtd document type. Such a description contains

• most importantly the PropertyList of the device
• the list of input interfaces
• the list of output interfaces
• the list of needed libraries

---

Member Typedef Documentation

typedef std::vector<IfaceDescr> simth::DeviceDescription::IfaceList

---

Constructor & Destructor Documentation

simth::DeviceDescription::DeviceDescription (   )

Constructor with empty values.

simth::DeviceDescription::DeviceDescription (  const DeviceDescription &   )

Copy constructor (required because of pointer copying)

simth::DeviceDescription::~DeviceDescription (   )

Destructor.

---

Member Function Documentation

DeviceDescription& simth::DeviceDescription::operator= (  const DeviceDescription &   )

Copy assignment (required because of pointer copying)

bool simth::DeviceDescription::operator== (  const DeviceDescription &  d  )  const

Comparison. Necessary for std::map instantiation.

bool simth::DeviceDescription::operator< (  const DeviceDescription &  d  )  const

Comparison for sorting. Necessary for std::map instantiation.

const std::string& simth::DeviceDescription::name (   )  const

Returns the name of the device

const std::string& simth::DeviceDescription::type (   )  const

Returns the C++ type name of the device

const std::string& simth::DeviceDescription::extends (   )  const

Returns the C++ type name of this device's base device, i.e. the one that this device is derived from or that this device extends.

const std::string& simth::DeviceDescription::type_escaped (   )  const

Returns the C++ type name of the device, but escaped to conform to XML ID-attribute production (i.e. without angular brackets lesser-than and greater-than, which makes a difference for template class names)

unsigned simth::DeviceDescription::nr_input_interfaces (   )  const

Returns the number of input interfaces.

unsigned simth::DeviceDescription::nr_output_interfaces (   )  const

Returns the number of output interfaces.

const DeviceDescription::IfaceList& simth::DeviceDescription::input_interfaces (   )  const

Returns the list of string pairs that describe the input interfaces. The first element of each pair is the interface type, and the second element is the description.

const DeviceDescription::IfaceList& simth::DeviceDescription::output_interfaces (   )  const

Returns the list of string pairs that describe the output interfaces. The first element of each pair is the interface type, and the second element is the description.

const PropertyList& simth::DeviceDescription::properties (   )  const

Returns the PropertyList of the device.

const Property::list_string& simth::DeviceDescription::libraries (   )  const

Returns the list of needed libraries for the device.

bool simth::DeviceDescription::isAbstract (   )  const

Returns true if the device is abstract (i.e. you cannot instantiate a class of this type).

const std::string& simth::DeviceDescription::description (   )  const

Returns the textual description of this device

void simth::DeviceDescription::toStream (  std::ostream &  os  )  const

writes a human-readable description to the given ostream.

static std::string simth::DeviceDescription::typename_escape (  const std::string &  s  )  [static]

Escapes a C++ type name for XML encoding: By convention, we replace each opening triangle brace (lesser-than) "<" by a minus "-" and each closing triangle brace (greater-than) ">" by a dot.

static std::string simth::DeviceDescription::typename_unescape (  const std::string &  s  )  [static]

Unescapes a XML encoded C++ type name into normal C++ syntax: The escaping convention is that we replace each opening triangle brace (lesser-than) "<" by a minus "-" and each closing triangle brace (greater-than) ">" by a dot.

---

Friends And Related Function Documentation

friend class DeviceManager [friend]

---