Protocol::Tags Class Reference

#include <Protocol.hpp>

Inherits NonInstantiable< Tags >.

Static Public Member Functions
static const char *	attr_array_delimiter ()
static const char *	attr_array_size ()
static const char *	attr_array_type ()
static const char *	attr_clientid ()
static const char *	attr_descr ()
static const char *	attr_frameid ()
static const char *	attr_key ()
static const char *	attr_pretty_name ()
static const char *	key_restricted_values ()
static const char *	attr_uri_schemes ()
static const char *	key_options ()
static const char *	key_properties ()
static const char *	key_signals ()
static const char *	node_doc ()
static const char *	node_frame ()
static const char *	node_map ()
static const char *	node_value ()
static const char *	node_array ()
static const char *	node_type_reply ()
static const char *	node_type_signal ()

Detailed Description

Provides tags related to the XML protocol The first word of each function indicates the place it should be used in the XML tree:

• node_xxx : gives a node name
• attr_xxx : gives an attribute name
• key_xxx : gives a value for 'key' attribute
• node_type_xxx : gives a value for 'type' key in a 'frame' node

  Author

  Quentin Gasper

Definition at line 38 of file Protocol.hpp.

Member Function Documentation

const char * attr_array_delimiter ( )

static

Returns

Returns the name for attribute 'delimiter' of arrays.

Definition at line 30 of file Protocol.cpp.

const char * attr_array_size ( )

static

Returns

Returns the name for attribute 'size' of arrays.

Definition at line 32 of file Protocol.cpp.

const char * attr_array_type ( )

static

Returns

Returns the name for attribute 'type' of arrays.

Definition at line 34 of file Protocol.cpp.

const char * attr_clientid ( )

static

Returns

Returns the name for attribute that maintains the client UUID.

Definition at line 36 of file Protocol.cpp.

const char * attr_descr ( )

static

Returns

Returns the name for attribute that maintains a description.

Definition at line 38 of file Protocol.cpp.

const char * attr_frameid ( )

static

Returns

Returns the name for attribute that maintains the frame UUID.

Definition at line 40 of file Protocol.cpp.

const char * attr_key ( )

static

Returns

Returns the name for attribute that maintains a name (the key).

Definition at line 42 of file Protocol.cpp.

const char * attr_pretty_name ( )

static

Returns

Returns the name for attribute that maintains a pretty name.

Definition at line 44 of file Protocol.cpp.

const char * attr_uri_schemes ( )

static

Returns

Returns the name for attribute that maintains protocols for URI options/arrays.

Definition at line 48 of file Protocol.cpp.

const char * key_options ( )

static

Returns

Returns the key value for option maps.

Definition at line 50 of file Protocol.cpp.

const char * key_properties ( )

static

Returns

Returns the key value for property maps.

Definition at line 52 of file Protocol.cpp.

const char * key_restricted_values ( )

static

Definition at line 46 of file Protocol.cpp.

const char * key_signals ( )

static

Returns

Returns the key value for signal maps.

Definition at line 54 of file Protocol.cpp.

const char * node_array ( )

static

Returns

Returns the node name for arrays.

Definition at line 56 of file Protocol.cpp.

const char * node_doc ( )

static

Returns

Returns the node name for XML document.

Definition at line 58 of file Protocol.cpp.

const char * node_frame ( )

static

Returns

Returns the node name for frames.

Definition at line 60 of file Protocol.cpp.

const char * node_map ( )

static

Returns

Returns the node name for maps.

Definition at line 62 of file Protocol.cpp.

const char * node_type_reply ( )

static

Returns

Returns the type for reply frames.

Definition at line 66 of file Protocol.cpp.

const char * node_type_signal ( )

static

Returns

Returns the type for signal frames.

Definition at line 68 of file Protocol.cpp.

const char * node_value ( )

static

Returns

Returns the node name for values.

Definition at line 64 of file Protocol.cpp.

---

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

• cf3/common/XML/Protocol.hpp
• cf3/common/XML/Protocol.cpp