NetworkGraphBuilder Interface Reference

Gives GraphBuilder a few extra methods that would be needed for network communications. More...

Inheritance diagram for NetworkGraphBuilder:

GraphBuilder

List of all members.

Public Member Functions

string GetProperty (string key)
 Retrieves the string value of a given key.
int GetPropertyAsInt (string key)
 Retrieves the integer value of a given key.
int GetPropertyAsIntWithDefault (string key, int value)
 Retrieves the integer of a given key but will return a default integer if that key doesn't exist.
string GetPropertyWithDefault (string key, string value)
 Retrieves the value of a given key but will return a default if that key doesn't exist.


Detailed Description

Gives GraphBuilder a few extra methods that would be needed for network communications.

Member Function Documentation

string GetProperty ( string  key  ) 

Retrieves the string value of a given key.

Parameters:
key The key to get the string value of.
Returns:
The string value of the given key.
Exceptions:
Exception If an underlying method throws an exception, it will be wrapped and thrown as a Exception.

int GetPropertyAsInt ( string  key  ) 

Retrieves the integer value of a given key.

Parameters:
key The key to get the integer value of.
Returns:
The integer value of the given key.
Exceptions:
Exception If an underlying method throws an exception, it will be wrapped and thrown as a Exception.

int GetPropertyAsIntWithDefault ( string  key,
int  value 
)

Retrieves the integer of a given key but will return a default integer if that key doesn't exist.

Parameters:
key The key to get the integer value of
value The default integer value to return if the key doesn't exist
Returns:
The integer value of the given key or the default integer value if the key doesn't exist
Exceptions:
Exception If an underlying method throws an exception, it will be wrapped and thrown as a Exception.

string GetPropertyWithDefault ( string  key,
string  value 
)

Retrieves the value of a given key but will return a default if that key doesn't exist.

Parameters:
key The key to get the value of
value The default value to return if the key doesn't exist
Returns:
The string value of the given key or the default value if the key doesn't exist
Exceptions:
Exception If an underlying method throws an exception, it will be wrapped and thrown as a Exception.


The documentation for this interface was generated from the following file:
Generated on Mon Aug 27 12:26:46 2007 for RebeccaAIML by  doxygen 1.5.3