PlugInsInterfaces.DataTypes.IGDataDictionary< TKey, TValue > Interface Template Reference

An interface wrapper around a mutable dictionary to expose common methods such as add, delete, enumerate More...

Public Member Functions
void	AddValue (TValue value)
	Add the given value to the dictionary More...
TValue	ValueForKey (TKey key)
	Returns the value associated with a given key; Returns Null if the key does not exist More...
TValue	CreateValue (IData data, int type=0)
	Returns a new object of the same type that the dictionary holds More...
bool	KeyExists (TKey key)
	Returns true if the key exists in the dictionary; returns false otherwise More...
bool	DeleteValue (IData data, TKey key)
	Deletes the given value from the dictionary More...

Properties
IEnumerable< TValue >	AllValues [get]
	Returns an enumerable sequence of all values contained in the dictionary More...

Detailed Description

An interface wrapper around a mutable dictionary to expose common methods such as add, delete, enumerate

Definition at line 13 of file IGDataDictionary.cs.

Member Function Documentation

void PlugInsInterfaces.DataTypes.IGDataDictionary< TKey, TValue >.AddValue

(

TValue

value

)

Add the given value to the dictionary

TValue PlugInsInterfaces.DataTypes.IGDataDictionary< TKey, TValue >.CreateValue	(	IData	data,
		int	type = 0
	)

Returns a new object of the same type that the dictionary holds

Parameters

type	Acts as an identifier when needed.

List of cases where identifier is needed:

Identifier for creating Process - Value 1: Stationary Process. Value 2: Transportation Process. Default: Stationary Process

Identifier for creating Modes - Value 1: TankerBarge Mode. Value 2:Truck Mode. Value 3:Pipeline Mode. Value 4:Rail Mode. Value 5:Connector Mode. Default: Connector

Returns

bool PlugInsInterfaces.DataTypes.IGDataDictionary< TKey, TValue >.DeleteValue	(	IData	data,
		TKey	key
	)

Deletes the given value from the dictionary

bool PlugInsInterfaces.DataTypes.IGDataDictionary< TKey, TValue >.KeyExists

(

TKey

key

)

Returns true if the key exists in the dictionary; returns false otherwise

TValue PlugInsInterfaces.DataTypes.IGDataDictionary< TKey, TValue >.ValueForKey

(

TKey

key

)

Returns the value associated with a given key; Returns Null if the key does not exist

Property Documentation

IEnumerable<TValue> PlugInsInterfaces.DataTypes.IGDataDictionary< TKey, TValue >.AllValues

get

Returns an enumerable sequence of all values contained in the dictionary

Definition at line 56 of file IGDataDictionary.cs.

---

The documentation for this interface was generated from the following file:

• C:/Users/ddieffenthaler/Desktop/SVN/source/greet-dev/main/PlugInsInterfaces/DataManipulation/IGDataDictionary.cs