The Properties class represents a persistent set of properties. More...

Public Member Functions
def	__del__
	Destructor.
def	__init__
	Constructor.
def	__str__
def	assigmentOperator
	Assignment operator.
def	clear
	If key exists in the children.
def	createNode
def	findNode
	Find node of properties Properties* const Properties::findNode(const std::string& key) const.
def	getDefault
	Set value as the default value to specified key's property.
def	getDefaultValue
def	getLeaf
def	getName
def	getNode
	Get node of Properties.
def	getProperty
	Searches for the property with the specified key in this property.
def	getRoot
def	getValue
def	hasKey
	If key exists in the children.
def	indent
def	list
	Prints this property list out to the specified output stream.
def	load
	Loads property list consists of key:value from input stream.
def	mergeProperties
	Merge properties.
def	propertyNames
	Returns an vector of all the keys in this property.
def	removeNode
	Get node of Properties.
def	save
	Save the properties list to the stream.
def	setDefault
	Sets a default value associated with key in the property list.
def	setDefaults
	Sets a default value associated with key in the property list.
def	setProperty
	Sets a value associated with key in the property list.
def	size
	Get number of Properties.
def	split
def	splitKeyValue
def	store
	Stores property list to the output stream.
Public Attributes
	default_value
	empty
	leaf
	name
	root
	value
Private Member Functions
def	_dump
def	_getNode
def	_propertyNames
def	_store

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.

Definition at line 83 of file Properties.py.

Constructor & Destructor Documentation

def OpenRTM_aist.Properties.Properties.__init__	(	self,
		key = `None`,
		value = `None`,
		defaults_map = `None`,
		defaults_str = `None`,
		num = `None`,
		prop = `None`
	)

Constructor.

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

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

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

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);

Definition at line 164 of file Properties.py.

def OpenRTM_aist.Properties.Properties.__del__ ( self )

Destructor.

Definition at line 261 of file Properties.py.

Member Function Documentation

def OpenRTM_aist.Properties.Properties.__str__ ( self )

Definition at line 1375 of file Properties.py.

def OpenRTM_aist.Properties.Properties._dump	(	self,
		out,
		curr,
		index
	)	`[private]`

Definition at line 1336 of file Properties.py.

def OpenRTM_aist.Properties.Properties._getNode	(	self,
		keys,
		index,
		curr
	)	`[private]`

Definition at line 1225 of file Properties.py.

def OpenRTM_aist.Properties.Properties._propertyNames	(	self,
		names,
		curr_name,
		curr
	)	`[private]`

Definition at line 1253 of file Properties.py.

def OpenRTM_aist.Properties.Properties._store	(	self,
		out,
		curr_name,
		curr
	)	`[private]`

Definition at line 1278 of file Properties.py.

def OpenRTM_aist.Properties.Properties.assigmentOperator	(	self,
		prop
	)

Assignment operator.

Parameters:

self
prop	OpenRTM_aist.Properties

Definition at line 231 of file Properties.py.

def OpenRTM_aist.Properties.Properties.clear ( self )

If key exists in the children.

Definition at line 1091 of file Properties.py.

def OpenRTM_aist.Properties.Properties.createNode	(	self,
		key
	)

Definition at line 1022 of file Properties.py.

def OpenRTM_aist.Properties.Properties.findNode	(	self,
		key
	)

Find node of properties Properties* const Properties::findNode(const std::string& key) const.

Definition at line 971 of file Properties.py.

def OpenRTM_aist.Properties.Properties.getDefault	(	self,
		key
	)

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

Definition at line 423 of file Properties.py.

def OpenRTM_aist.Properties.Properties.getDefaultValue ( self )

Definition at line 319 of file Properties.py.

def OpenRTM_aist.Properties.Properties.getLeaf ( self )

Definition at line 336 of file Properties.py.

def OpenRTM_aist.Properties.Properties.getName ( self )

Definition at line 285 of file Properties.py.

def OpenRTM_aist.Properties.Properties.getNode	(	self,
		key
	)

Get node of Properties.

Definition at line 994 of file Properties.py.

def OpenRTM_aist.Properties.Properties.getProperty	(	self,
		key,
		default = `None`
	)

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

Searches for the property with the specified key in this property list. 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.

Definition at line 385 of file Properties.py.

def OpenRTM_aist.Properties.Properties.getRoot ( self )

Definition at line 353 of file Properties.py.

def OpenRTM_aist.Properties.Properties.getValue ( self )

Definition at line 302 of file Properties.py.

def OpenRTM_aist.Properties.Properties.hasKey	(	self,
		key
	)

If key exists in the children.

Definition at line 1074 of file Properties.py.

def OpenRTM_aist.Properties.Properties.indent	(	self,
		index
	)

Definition at line 1311 of file Properties.py.

def OpenRTM_aist.Properties.Properties.list	(	self,
		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.

Definition at line 586 of file Properties.py.

def OpenRTM_aist.Properties.Properties.load	(	self,
		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.

Definition at line 753 of file Properties.py.

def OpenRTM_aist.Properties.Properties.mergeProperties	(	self,
		prop
	)

Merge properties.

Definition at line 1114 of file Properties.py.

def OpenRTM_aist.Properties.Properties.propertyNames ( self )

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.

Definition at line 940 of file Properties.py.

def OpenRTM_aist.Properties.Properties.removeNode	(	self,
		leaf_name
	)

Get node of Properties.

Definition at line 1048 of file Properties.py.

def OpenRTM_aist.Properties.Properties.save	(	self,
		out,
		header
	)

Save the properties list to the stream.

Deprecated.

Parameters:

out	The output stream
header	A description of the property list

Definition at line 817 of file Properties.py.

def OpenRTM_aist.Properties.Properties.setDefault	(	self,
		key,
		value
	)

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

Definition at line 501 of file Properties.py.

def OpenRTM_aist.Properties.Properties.setDefaults	(	self,
		defaults,
		num = `None`
	)

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

Definition at line 536 of file Properties.py.

def OpenRTM_aist.Properties.Properties.setProperty	(	self,
		key,
		value = `None`
	)

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.

Definition at line 463 of file Properties.py.

def OpenRTM_aist.Properties.Properties.size ( self )

Get number of Properties.

Definition at line 960 of file Properties.py.

def OpenRTM_aist.Properties.Properties.split	(	self,
		_str,
		delim,
		value
	)

Definition at line 1188 of file Properties.py.

def OpenRTM_aist.Properties.Properties.splitKeyValue	(	self,
		_str,
		key,
		value
	)

Definition at line 1144 of file Properties.py.

def OpenRTM_aist.Properties.Properties.store	(	self,
		out,
		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: