This class contains a collection of key-value pairs, defining event meta data which can be used to create filter rules. More...

Public Member Functions
bool	containsKey (string key)
	Returns true if the key is contained within the dictionary.

void	copy (nEventProperties p_dictionary)
	Copies the properties from one to this.

object	get (object key)
	Get the value as an Object If the input paramter is not of type String, returns null.

object	get (string key)
	Get the value as an Object.

bool	getBoolean (string key)
	Retrieves the data from the table based on the key as a bool.

bool[]	getBooleanArray (string key)
	Retrieves a bool[] from the properties.

byte	getByte (string key)
	Retrieves a byte by the name given.

byte[]	getByteArray (string key)
	Retrieves a byte[] from the dictionary.

char	getChar (string key)
	Retrieves a char from the properties.

char[]	getCharArray (string key)
	Retrieves a char[] from the properties.

string	getClass (string key)
	Get the class name of the value represented by the key.

nEventProperties	getDictionary (string key)
	Retrieve a nEventProperty from this one.

nEventProperties[]	getDictionaryArray (string key)
	Return an array of nEventProperties.

double	getDouble (string key)
	Retrieves the data from the table based on the key as a double.

double[]	getDoubleArray (string key)
	Retrieves a double[] from the properties.

nEventPropertiesIterator	getEntrySet ()
	Get an iterator of the key and values in an Map.Entry.

float	getFloat (string key)
	Retrieves a float from the properties.

float[]	getFloatArray (string key)
	Retrieves a float[] from the properties.

int	getInt (string key)
	Retrieves an int from the properties.

int[]	getIntArray (string key)
	Gets an int[] from the properties.

IEnumerator< string >	getKeys ()
	Get an IEnumerator of keys.

IEnumerator< string >	getKeysAsStrings ()
	Get an IEnumerator of keys as Strings.

long	getLong (string key)
	Retrieves the data from the table based on the key as a long.

long[]	getLongArray (string key)
	Retrieves a long[] from the properties.

short	getShort (string key)
	Retrieves a short from the properties.

short[]	getShortArray (string key)
	Retrieves an array of shorts.

int	getSize ()
	Return the number of properties held.

string	getString (string key)
	Retrieves the data from the table based on the key as a string.

string[]	getStringArray (string key)
	Retrieves a String[].

IEnumerator< object >	getValues ()
	Get an IEnumerator of values.

bool	isValid ()
	Returns true if the dictionary is consistent and contains no errors.

void	merge (nEventProperties props, bool overwrite)
	Adds the values from the supplied properties to this object.

	nEventProperties ()
	Default constructor.

	nEventProperties (nEventProperties ed)
	Constructs an event properties object that is a copy of the specified event properties.

	nEventProperties (nEventProperties ed, bool copyNew)
	Constructs an event properties object that is a copy of the specified event properties, but depending on the copyNew, will construct new dictionary entries to prevent dictionary entries being overwritten by subsequent uses of the event object and event properties.

	nEventProperties (string serializedString)
	Constructor using a string from the .toString() method.

void	put (string key, bool value)
	Places a key value pair into the dictionary.

void	put (string key, bool[] value)
	Places a bool[] into the properties.

void	put (string key, byte b)
	Places a byte into the properties.

void	put (string key, byte[] b)
	Places a byte[] into the properties.

void	put (string key, char c)
	Puts a char into the properties.

void	put (string key, char[] c)
	Puts an array of chars into the properties.

void	put (string key, double value)
	Places a key value pair into the dictionary.

void	put (string key, double[] value)
	Places a double[] into the properties.

void	put (string key, float value)
	Places a key value pair into the properties.

void	put (string key, float[] value)
	Puts a float[] into the properties.

void	put (string key, int value)
	Places a key value pair into the dictionary.

void	put (string key, int[] value)
	Places a int[] into the properties.

void	put (string key, long value)
	Places a key value pair into the dictionary.

void	put (string key, long[] value)
	Places a long[] into the properties.

void	put (string key, nEventProperties value)
	Put an nEventproperties into this one to enable nested properties.

void	put (string key, nEventProperties[] value)
	Put an nEventProperies[] into this property to enable nested properties.

void	put (string key, short s)
	places a short into the properties

void	put (string key, short[] s)
	Places an array of shorts into the properties.

void	put (string key, string value)
	Places a key value pair into the dictionary.

void	put (string key, string[] value)
	Places a String[] into the properties.

void	remove (string key)
	Removes the value index by the key.

string	ToString ()
	Converts this object into a string.

Detailed Description

This class contains a collection of key-value pairs, defining event meta data which can be used to create filter rules.

Constructor & Destructor Documentation

◆ nEventProperties() [1/3]

com.pcbsys.nirvana.client.nEventProperties.nEventProperties ( nEventProperties ed )

Constructs an event properties object that is a copy of the specified event properties.

Parameters

ed	the event properties object to be copied

◆ nEventProperties() [2/3]

com.pcbsys.nirvana.client.nEventProperties.nEventProperties	(	nEventProperties	ed,
		bool	copyNew
	)

Constructs an event properties object that is a copy of the specified event properties, but depending on the copyNew, will construct new dictionary entries to prevent dictionary entries being overwritten by subsequent uses of the event object and event properties.

Parameters

ed	the event properties object to be copied
copyNew	re-construct the entries rather than copying the references to the new event properties

◆ nEventProperties() [3/3]

com.pcbsys.nirvana.client.nEventProperties.nEventProperties ( string serializedString )

Constructor using a string from the .toString() method.

Parameters

serializedString serialized string used to construct the nEventProperties

Member Function Documentation

◆ containsKey()

bool com.pcbsys.nirvana.client.nEventProperties.containsKey ( string key )

Returns true if the key is contained within the dictionary.

Parameters

key	Name of the key to search for

Returns: True if the properties contains the key

◆ copy()

void com.pcbsys.nirvana.client.nEventProperties.copy ( nEventProperties p_dictionary )

Copies the properties from one to this.

Parameters

p_dictionary dictionary to copy

◆ get() [1/2]

object com.pcbsys.nirvana.client.nEventProperties.get ( object key )

Get the value as an Object If the input paramter is not of type String, returns null.

Parameters

key	String key to return

Returns: Object of the value

◆ get() [2/2]

object com.pcbsys.nirvana.client.nEventProperties.get ( string key )

Get the value as an Object.

Parameters

key	String key to return

Returns: Object of the value

◆ getBoolean()

bool com.pcbsys.nirvana.client.nEventProperties.getBoolean ( string key )

Retrieves the data from the table based on the key as a bool.

Parameters

key	Key to reference the data

Returns: a bool with the value associated with this key

◆ getBooleanArray()

bool[] com.pcbsys.nirvana.client.nEventProperties.getBooleanArray ( string key )

Retrieves a bool[] from the properties.

Parameters

key	Name of the bool[]

Returns: bool[]

◆ getByte()

byte com.pcbsys.nirvana.client.nEventProperties.getByte ( string key )

Retrieves a byte by the name given.

Parameters

key	Name for the byte

Returns: byte value

◆ getByteArray()

byte[] com.pcbsys.nirvana.client.nEventProperties.getByteArray ( string key )

Retrieves a byte[] from the dictionary.

Parameters

key	name for the byte[]

Returns: byte[]

◆ getChar()

char com.pcbsys.nirvana.client.nEventProperties.getChar ( string key )

Retrieves a char from the properties.

Parameters

key	name of the char

Returns: char

◆ getCharArray()

char[] com.pcbsys.nirvana.client.nEventProperties.getCharArray ( string key )

Retrieves a char[] from the properties.

Parameters

key	name of the char array

Returns: char[]

◆ getClass()

string com.pcbsys.nirvana.client.nEventProperties.getClass ( string key )

Get the class name of the value represented by the key.

Parameters

key	String value to lookup

Returns: String class name of the value

◆ getDictionary()

nEventProperties com.pcbsys.nirvana.client.nEventProperties.getDictionary ( string key )

Retrieve a nEventProperty from this one.

Parameters

key	Name of the nEventProperty

Returns: a nEventProperty

◆ getDictionaryArray()

nEventProperties[] com.pcbsys.nirvana.client.nEventProperties.getDictionaryArray ( string key )

Return an array of nEventProperties.

Parameters

key	name of the array to return

Returns: nEventproperty[]

◆ getDouble()

double com.pcbsys.nirvana.client.nEventProperties.getDouble ( string key )

Retrieves the data from the table based on the key as a double.

Parameters

key	Key to reference the data

Returns: a double with the value associated with this key

◆ getDoubleArray()

double[] com.pcbsys.nirvana.client.nEventProperties.getDoubleArray ( string key )

Retrieves a double[] from the properties.

Parameters

key	Name of the double[]

Returns: double[]

◆ getEntrySet()

nEventPropertiesIterator com.pcbsys.nirvana.client.nEventProperties.getEntrySet ( )

Get an iterator of the key and values in an Map.Entry.

Allows the user to get both the key and value from one iteration of the nEventProperties.

Returns: nEventPropertiesIterator Map.Entrys in the properties

◆ getFloat()

float com.pcbsys.nirvana.client.nEventProperties.getFloat ( string key )

Retrieves a float from the properties.

Parameters

key	Name of the float

Returns: float value

◆ getFloatArray()

float[] com.pcbsys.nirvana.client.nEventProperties.getFloatArray ( string key )

Retrieves a float[] from the properties.

Parameters

key	Name of the float[]

Returns: float[]

◆ getInt()

int com.pcbsys.nirvana.client.nEventProperties.getInt ( string key )

Retrieves an int from the properties.

Parameters

key	Name of the int

Returns: int value

◆ getIntArray()

int[] com.pcbsys.nirvana.client.nEventProperties.getIntArray ( string key )

Gets an int[] from the properties.

Parameters

key	Name of the int[]

Returns: int[]

◆ getKeys()

IEnumerator< string > com.pcbsys.nirvana.client.nEventProperties.getKeys ( )

Get an IEnumerator of keys.

Returns: IEnumerator of keys

◆ getKeysAsStrings()

IEnumerator< string > com.pcbsys.nirvana.client.nEventProperties.getKeysAsStrings ( )

Get an IEnumerator of keys as Strings.

Returns: an IEnumerator of String objects representing the keys

◆ getLong()

long com.pcbsys.nirvana.client.nEventProperties.getLong ( string key )

Retrieves the data from the table based on the key as a long.

Parameters

key	Key to reference the data

Returns: a long with the value associated with this key

◆ getLongArray()

long[] com.pcbsys.nirvana.client.nEventProperties.getLongArray ( string key )

Retrieves a long[] from the properties.

Parameters

key	Name of the long[]

Returns: long[]

◆ getShort()

short com.pcbsys.nirvana.client.nEventProperties.getShort ( string key )

Retrieves a short from the properties.

Parameters

key	name of the short

Returns: short value

◆ getShortArray()

short[] com.pcbsys.nirvana.client.nEventProperties.getShortArray ( string key )

Retrieves an array of shorts.

Parameters

key	name of the short array

Returns: short[]

◆ getSize()

int com.pcbsys.nirvana.client.nEventProperties.getSize ( )

Return the number of properties held.

Returns: int size

◆ getString()

string com.pcbsys.nirvana.client.nEventProperties.getString ( string key )

Retrieves the data from the table based on the key as a string.

Parameters

key	Key to reference the data

Returns: a string with the value associated with this key

◆ getStringArray()

string[] com.pcbsys.nirvana.client.nEventProperties.getStringArray ( string key )

Retrieves a String[].

Parameters

key	Name of the String[]

Returns: String[]

◆ getValues()

IEnumerator< object > com.pcbsys.nirvana.client.nEventProperties.getValues ( )

Get an IEnumerator of values.

Returns: IEnumerator of values

◆ isValid()

bool com.pcbsys.nirvana.client.nEventProperties.isValid ( )

Returns true if the dictionary is consistent and contains no errors.

Returns: bool flag

◆ merge()

void com.pcbsys.nirvana.client.nEventProperties.merge	(	nEventProperties	props,
		bool	overwrite
	)

Adds the values from the supplied properties to this object.

If this object already has keys with the same name then the behaviour is driven by the bool overwrite.

Parameters

props	The nEventProperties object to merge with this copy
overwrite	If true then duplicate values will take the new value

◆ put() [1/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		bool	value
	)

Places a key value pair into the dictionary.

Parameters

key	Key to reference the data
value	Data to be stored

◆ put() [2/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		bool[]	value
	)

Places a bool[] into the properties.

Parameters

key	Name of the boolean[]
value	bool[]

◆ put() [3/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		byte	b
	)

Places a byte into the properties.

Parameters

key	name for the byte
b	byte

◆ put() [4/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		byte[]	b
	)

Places a byte[] into the properties.

Parameters

key	name for the byte[]
b	byte[]

◆ put() [5/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		char	c
	)

Puts a char into the properties.

Parameters

key	Name of the char
c	char value

◆ put() [6/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		char[]	c
	)

Puts an array of chars into the properties.

Parameters

key	Name of the char[]
c	char[]

◆ put() [7/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		double	value
	)

Places a key value pair into the dictionary.

Parameters

key	Key to reference the data
value	Data to be stored

◆ put() [8/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		double[]	value
	)

Places a double[] into the properties.

Parameters

key	Name of the double[]
value	double[]

◆ put() [9/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		float	value
	)

Places a key value pair into the properties.

Parameters

key	Key to reference the data
value	Data to be stored

◆ put() [10/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		float[]	value
	)

Puts a float[] into the properties.

Parameters

key	Name of the float[]
value	float[]

◆ put() [11/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		int	value
	)

Places a key value pair into the dictionary.

Parameters

key	Key to reference the data
value	Data to be stored

◆ put() [12/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		int[]	value
	)

Places a int[] into the properties.

Parameters

key	Name of the key
value	int[]

◆ put() [13/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		long	value
	)

Places a key value pair into the dictionary.

Parameters

key	Key to reference the data
value	Data to be stored

◆ put() [14/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		long[]	value
	)

Places a long[] into the properties.

Parameters

key	name of the long[]
value	long[]

◆ put() [15/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		nEventProperties	value
	)

Put an nEventproperties into this one to enable nested properties.

Parameters

key	name of this value
value	nEventProperty to insert

◆ put() [16/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		nEventProperties[]	value
	)

Put an nEventProperies[] into this property to enable nested properties.

Parameters

key	Name to call this
value	Array of nEventProperties

◆ put() [17/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		short	s
	)

places a short into the properties

Parameters

key	name of the short
s	short value

◆ put() [18/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		short[]	s
	)

Places an array of shorts into the properties.

Parameters

key	Name for the array
s	short[]

◆ put() [19/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		string	value
	)

Places a key value pair into the dictionary.

Parameters

key	Key to reference the data
value	Data to be stored

◆ put() [20/20]

void com.pcbsys.nirvana.client.nEventProperties.put	(	string	key,
		string[]	value
	)

Places a String[] into the properties.

Parameters

key	Name for the value
value	String[]

◆ remove()

void com.pcbsys.nirvana.client.nEventProperties.remove ( string key )

Removes the value index by the key.

Parameters

key	Key to remove

◆ ToString()

string com.pcbsys.nirvana.client.nEventProperties.ToString ( )

Converts this object into a string.

Returns: String representation of this object

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ nEventProperties() [1/3]

◆ nEventProperties() [2/3]

◆ nEventProperties() [3/3]

Member Function Documentation

◆ containsKey()

◆ copy()

◆ get() [1/2]

◆ get() [2/2]

◆ getBoolean()

◆ getBooleanArray()

◆ getByte()

◆ getByteArray()

◆ getChar()

◆ getCharArray()

◆ getClass()

◆ getDictionary()

◆ getDictionaryArray()

◆ getDouble()

◆ getDoubleArray()

◆ getEntrySet()

◆ getFloat()

◆ getFloatArray()

◆ getInt()

◆ getIntArray()

◆ getKeys()

◆ getKeysAsStrings()

◆ getLong()

◆ getLongArray()

◆ getShort()

◆ getShortArray()

◆ getSize()

◆ getString()

◆ getStringArray()

◆ getValues()

◆ isValid()

◆ merge()

◆ put() [1/20]

◆ put() [2/20]

◆ put() [3/20]

◆ put() [4/20]

◆ put() [5/20]

◆ put() [6/20]

◆ put() [7/20]

◆ put() [8/20]

◆ put() [9/20]

◆ put() [10/20]

◆ put() [11/20]

◆ put() [12/20]

◆ put() [13/20]

◆ put() [14/20]

◆ put() [15/20]

◆ put() [16/20]

◆ put() [17/20]

◆ put() [18/20]

◆ put() [19/20]

◆ put() [20/20]

◆ remove()

◆ ToString()