Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

RTC::Properties Class Reference

#include <Properties.h>

List of all members.

Public Member Functions

 Properties (const char *key="", const char *value="")
 Constructor.
 Properties (std::map< std::string, std::string > &defaults)
 Constructor.
 Properties (const char *defaults[], long num=LONG_MAX)
 Constructor.
 Properties (const Properties &prop)
 Copy Constructor.
Propertiesoperator= (const Properties &prop)
 Assignment operator.
virtual ~Properties ()
 Destructor.
const char * getName () const
const char * getVlue () const
const char * getDefaultValue () const
const std::vector< Properties * > & getLeaf () const
const PropertiesgetRoot () const
const std::string & getProperty (const std::string &key) const
 Searches for the property with the specified key in this property.
const std::string & getProperty (const std::string &key, const std::string &def) const
 Searches for the property with the specified key in this property.
const std::string & operator[] (const std::string &key) const
 Searches for the property with the specified key in this property.
std::string & operator[] (const std::string &key)
 Searches for the property with the specified key in this property.
const std::string & getDefault (const std::string &key) const
 Set value as the default value to specified key's property.
std::string setProperty (const std::string &key, const std::string &value)
 Sets a value associated with key in the property list.
std::string setDefault (const std::string &key, const std::string &value)
 Sets a default value associated with key in the property list.
void setDefaults (const char *defaults[], long num=LONG_MAX)
 Sets a default value associated with key in the property list.
void list (std::ostream &out)
 Prints this property list out to the specified output stream.
void load (std::istream &inStream)
 Loads property list consists of key:value from input stream.
void save (std::ostream &out, const std::string &header)
 Save the properties list to the stream.
void store (std::ostream &out, const std::string &header)
 Stores property list to the output stream.
std::vector< std::string > propertyNames () const
 Returns an vector of all the keys in this property.
int size () const
 Get number of Properties.
PropertiesgetNode (const std::string &key) const
 Get node of Properties.
bool createNode (const char *key)
PropertiesremoveNode (const char *leaf_name)
 Get node of Properties.
PropertieshasKey (const char *key) const
 If key exists in the children.
void clear ()
 If key exists in the children.
Propertiesoperator<< (const Properties &prop)
 Merge properties.

Static Protected Member Functions

static void splitKeyValue (const std::string &str, std::string &key, std::string &value)
static bool split (const std::string &str, const char delim, std::vector< std::string > &value)
static Properties_getNode (std::vector< std::string > &keys, std::vector< Properties * >::size_type index, const Properties *curr)
static void _propertiyNames (std::vector< std::string > &names, std::string curr_name, const Properties *curr)
static void _store (std::ostream &out, std::string curr_name, Properties *curr)
static std::ostream & _dump (std::ostream &out, const Properties &curr, int index)
static std::string indent (int index)

Friends

std::ostream & operator<< (std::ostream &lhs, const Properties &rhs)


Detailed Description

The Properties class represents a persistent set of properties. The Properties can be saved to a stream or loaded from a stream. Each key and its corresponding value in the property list is a string.

A property list can contain another property list as its "defaults"; this second property list is searched if the property key is not found in the original property list.

Because Properties inherits from Hashtable, the put and putAll methods can be applied to a Properties object. Their use is strongly discouraged as they allow the caller to insert entries whose keys or values are not Strings. The setProperty method should be used instead. If the store or save method is called on a "compromised" Properties object that contains a non-String key or value, the call will fail.

The load and store methods load and store properties in a simple line-oriented format specified below. This format uses the ISO 8859-1 character encoding. Characters that cannot be directly represented in this encoding can be written using Unicode escapes ; only a single 'u' character is allowed in an escape sequence. The native2ascii tool can be used to convert property files to and from other character encodings.

This class has almost same methods of Java's Properties class. Input and Output stream of this properties are compatible each other except Unicode encoded property file.


Constructor & Destructor Documentation

RTC::Properties::Properties const char *  key = "",
const char *  value = ""
 

Constructor.

Creates a root node of Property with root's key and value.

RTC::Properties::Properties std::map< std::string, std::string > &  defaults  ) 
 

Constructor.

Creates an Properties with default value of std::string map.

RTC::Properties::Properties const char *  defaults[],
long  num = LONG_MAX
 

Constructor.

Creates an empty property list with the specified defaults. The default values are given by array of char*, which should be pairs of "key" and "value". The end of list is specified by argument "num", which specifies number of array or null character of key. The following is an example.

const char* defaults = { "key1", "value1", "key2", "value2", "key3", "value3", "key4", "value4", "key5", "value5", "" }; Properties p(defaults); // or Properties p(defaults, 10);

RTC::Properties::Properties const Properties prop  ) 
 

Copy Constructor.

All of given Properties's keys, values and default values are copied to new Properties.

virtual RTC::Properties::~Properties  )  [virtual]
 

Destructor.


Member Function Documentation

static std::ostream& RTC::Properties::_dump std::ostream &  out,
const Properties curr,
int  index
[static, protected]
 

static Properties* RTC::Properties::_getNode std::vector< std::string > &  keys,
std::vector< Properties * >::size_type  index,
const Properties curr
[static, protected]
 

static void RTC::Properties::_propertiyNames std::vector< std::string > &  names,
std::string  curr_name,
const Properties curr
[static, protected]
 

static void RTC::Properties::_store std::ostream &  out,
std::string  curr_name,
Properties curr
[static, protected]
 

void RTC::Properties::clear  ) 
 

If key exists in the children.

bool RTC::Properties::createNode const char *  key  )  [inline]
 

const std::string& RTC::Properties::getDefault const std::string &  key  )  const
 

Set value as the default value to specified key's property.

const char* RTC::Properties::getDefaultValue  )  const [inline]
 

const std::vector<Properties*>& RTC::Properties::getLeaf  )  const [inline]
 

const char* RTC::Properties::getName  )  const [inline]
 

Properties* RTC::Properties::getNode const std::string &  key  )  const
 

Get node of Properties.

const std::string& RTC::Properties::getProperty const std::string &  key,
const std::string &  def
const
 

Searches for the property with the specified key in this property.

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns the default value argument if the property is not found.

Parameters:
key the property key
defaultValue a default value.
Returns:
the value in this property list with the specified key value.

const std::string& RTC::Properties::getProperty const std::string &  key  )  const
 

Searches for the property with the specified key in this property.

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns null if the property is not found.

Parameters:
key the property key.
Returns:
the value in this property list with the specified key value.

const Properties* RTC::Properties::getRoot  )  const [inline]
 

const char* RTC::Properties::getVlue  )  const [inline]
 

Properties* RTC::Properties::hasKey const char *  key  )  const
 

If key exists in the children.

static std::string RTC::Properties::indent int  index  )  [static, protected]
 

void RTC::Properties::list std::ostream &  out  ) 
 

Prints this property list out to the specified output stream.

Prints this property list out to the specified output stream. This method is useful for debugging.

Parameters:
out an output stream.

void RTC::Properties::load std::istream &  inStream  ) 
 

Loads property list consists of key:value from input stream.

Reads a property list (key and element pairs) from the input stream. The stream is assumed to be using the ISO 8859-1 character encoding; that is each byte is one Latin1 character. Characters not in Latin1, and certain special characters, can be represented in keys and elements using escape sequences similar to those used for character and string literals The differences from the character escape sequences used for characters and strings are:

  • Octal escapes are not recognized.
  • The character sequence does not represent a backspace character.
  • The method does not treat a backslash character, \, before a non-valid escape character as an error; the backslash is silently dropped. For example, in a Java string the sequence "\z" would cause a compile time error. In contrast, this method silently drops the backslash. Therefore, this method treats the two character sequence "\b" as equivalent to the single character 'b'.
  • Escapes are not necessary for single and double quotes; however, by the rule above, single and double quote characters preceded by a backslash still yield single and double quote characters, respectively. An IllegalArgumentException is thrown if a malformed Unicode escape appears in the input.

This method processes input in terms of lines. A natural line of input is terminated either by a set of line terminator characters (
or or
) or by the end of the file. A natural line may be either a blank line, a comment line, or hold some part of a key-element pair. The logical line holding all the data for a key-element pair may be spread out across several adjacent natural lines by escaping the line terminator sequence with a backslash character, \. Note that a comment line cannot be extended in this manner; every natural line that is a comment must have its own comment indicator, as described below. If a logical line is continued over several natural lines, the continuation lines receive further processing, also described below. Lines are read from the input stream until end of file is reached.

A natural line that contains only white space characters is considered blank and is ignored. A comment line has an ASCII '#' or '!' as its first non-white space character; comment lines are also ignored and do not encode key-element information. In addition to line terminators, this method considers the characters space (' ', ''), tab ('', ''), and form feed ('', '') to be white space.

If a logical line is spread across several natural lines, the backslash escaping the line terminator sequence, the line terminator sequence, and any white space at the start the following line have no affect on the key or element values. The remainder of the discussion of key and element parsing will assume all the characters constituting the key and element appear on a single natural line after line continuation characters have been removed. Note that it is not sufficient to only examine the character preceding a line terminator sequence to see if the line terminator is escaped; there must be an odd number of contiguous backslashes for the line terminator to be escaped. Since the input is processed from left to right, a non-zero even number of 2n contiguous backslashes before a line terminator (or elsewhere) encodes n backslashes after escape processing.

The key contains all of the characters in the line starting with the first non-white space character and up to, but not including, the first unescaped '=', ':', or white space character other than a line terminator. All of these key termination characters may be included in the key by escaping them with a preceding backslash character; for example,

\:\=

would be the two-character key ":=". Line terminator characters can be included using and
escape sequences. Any white space after the key is skipped; if the first non-white space character after the key is '=' or ':', then it is ignored and any white space characters after it are also skipped. All remaining characters on the line become part of the associated element string; if there are no remaining characters, the element is the empty string "". Once the raw character sequences constituting the key and element are identified, escape processing is performed as described above.

As an example, each of the following three lines specifies the key "Truth" and the associated element value "Beauty":

Truth = Beauty
Truth:Beauty
Truth :Beauty
As another example, the following three lines specify a single property:

fruits apple, banana, pear, \
cantaloupe, watermelon, \
kiwi, mango
The key is "fruits" and the associated element is: "apple, banana, pear, cantaloupe, watermelon, kiwi, mango"Note that a space appears before each \ so that a space will appear after each comma in the final result; the \, line terminator, and leading white space on the continuation line are merely discarded and are not replaced by one or more other characters. As a third example, the line:

cheeses
specifies that the key is "cheeses" and the associated element is the empty string "".

Parameters:
inStream the input stream.

Properties& RTC::Properties::operator<< const Properties prop  ) 
 

Merge properties.

Properties& RTC::Properties::operator= const Properties prop  ) 
 

Assignment operator.

std::string& RTC::Properties::operator[] const std::string &  key  ) 
 

Searches for the property with the specified key in this property.

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns the default value argument if the property is not found.

Parameters:
key the property key
defaultValue a default value.
Returns:
the value in this property list with the specified key value.

const std::string& RTC::Properties::operator[] const std::string &  key  )  const
 

Searches for the property with the specified key in this property.

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns the default value argument if the property is not found.

Parameters:
key the property key
defaultValue a default value.
Returns:
the value in this property list with the specified key value.

std::vector<std::string> RTC::Properties::propertyNames  )  const
 

Returns an vector of all the keys in this property.

Returns an enumeration of all the keys in this property list, including distinct keys in the default property list if a key of the same name has not already been found from the main properties list.

Returns:
an vector of all the keys in this property list, including the keys in the default property list.

Properties* RTC::Properties::removeNode const char *  leaf_name  ) 
 

Get node of Properties.

void RTC::Properties::save std::ostream &  out,
const std::string &  header
 

Save the properties list to the stream.

Deprecated.

Parameters:
out The output stream
header A description of the property list

std::string RTC::Properties::setDefault const std::string &  key,
const std::string &  value
 

Sets a default value associated with key in the property list.

void RTC::Properties::setDefaults const char *  defaults[],
long  num = LONG_MAX
 

Sets a default value associated with key in the property list.

std::string RTC::Properties::setProperty const std::string &  key,
const std::string &  value
 

Sets a value associated with key in the property list.

This method sets the "value" associated with "key" in the property list. If the property list has a value of "key", old value is returned.

Parameters:
key the key to be placed into this property list.
value the value corresponding to key.
Returns:
the previous value of the specified key in this property list, or null if it did not have one.

int RTC::Properties::size  )  const
 

Get number of Properties.

static bool RTC::Properties::split const std::string &  str,
const char  delim,
std::vector< std::string > &  value
[static, protected]
 

static void RTC::Properties::splitKeyValue const std::string &  str,
std::string &  key,
std::string &  value
[static, protected]
 

void RTC::Properties::store std::ostream &  out,
const std::string &  header
 

Stores property list to the output stream.

Writes this property list (key and element pairs) in this Properties table to the output stream in a format suitable for loading into a Properties table using the load method. The stream is written using the ISO 8859-1 character encoding.

Properties from the defaults table of this Properties table (if any) are not written out by this method.

If the comments argument is not null, then an ASCII # character, the comments string, and a line separator are first written to the output stream. Thus, the comments can serve as an identifying comment.

Next, a comment line is always written, consisting of an ASCII # character, the current date and time (as if produced by the toString method of Date for the current time), and a line separator as generated by the Writer.

Then every entry in this Properties table is written out, one per line. For each entry the key string is written, then an ASCII =, then the associated element string. Each character of the key and element strings is examined to see whether it should be rendered as an escape sequence. The ASCII characters \, tab, form feed, newline, and carriage return are written as \, ,
, and , respectively. Characters less than and characters greater than are written as for the appropriate hexadecimal value xxxx. For the key, all space characters are written with a preceding \ character. For the element, leading space characters, but not embedded or trailing space characters, are written with a preceding \ character. The key and element characters #, !, =, and : are written with a preceding backslash to ensure that they are properly loaded.

After the entries have been written, the output stream is flushed. The output stream remains open after this method returns.

Parameters:
out an output stream.
header a description of the property list.


Friends And Related Function Documentation

std::ostream& operator<< std::ostream &  lhs,
const Properties rhs
[friend]
 


The documentation for this class was generated from the following file:
Generated on Fri Oct 5 05:16:06 2007 for OpenRTM by  doxygen 1.4.1