ITable Class Reference

Inheritance diagram for ITable:

Public Member Functions
virtual bool	ContainsKey (std::string key)=0
virtual bool	ContainsSubTable (std::string key)=0
virtual ITable *	GetSubTable (std::string key)=0
virtual EntryValue	GetValue (std::string key)=0
virtual void	PutValue (std::string key, ComplexData &value)=0
virtual void	RetrieveValue (std::string key, ComplexData &externalValue)=0
virtual void	PutNumber (std::string key, double value)=0
virtual double	GetNumber (std::string key)=0
virtual double	GetNumber (std::string key, double defaultValue)=0
virtual void	PutString (std::string key, std::string value)=0
virtual std::string	GetString (std::string key)=0
virtual std::string	GetString (std::string key, std::string defaultValue)=0
virtual void	PutBoolean (std::string key, bool value)=0
virtual bool	GetBoolean (std::string key)=0
virtual bool	GetBoolean (std::string key, bool defaultValue)=0
virtual void	AddTableListener (ITableListener *listener)=0
virtual void	AddTableListener (ITableListener *listener, bool immediateNotify)=0
virtual void	AddTableListener (std::string key, ITableListener *listener, bool immediateNotify)=0
virtual void	AddSubTableListener (ITableListener *listener)=0
virtual void	RemoveTableListener (ITableListener *listener)=0

Detailed Description

Definition at line 26 of file ITable.h.

Member Function Documentation

virtual void ITable::AddSubTableListener ( ITableListener *  listener )

pure virtual

This will immediately notify the listener of all current sub tables

Parameters

listener

Implemented in NetworkTable.

virtual void ITable::AddTableListener ( ITableListener *  listener )

pure virtual

Add a listener for changes to the table

Parameters

listener

the listener to add

Implemented in NetworkTable.

virtual void ITable::AddTableListener ( ITableListener *  listener, bool  immediateNotify  )

pure virtual

Add a listener for changes to the table

Parameters

listener	the listener to add
immediateNotify	if true then this listener will be notified of all current entries (marked as new)

Implemented in NetworkTable.

virtual void ITable::AddTableListener ( std::string  key, ITableListener *  listener, bool  immediateNotify  )

pure virtual

Add a listener for changes to a specific key the table

Parameters

key	the key to listen for
listener	the listener to add
immediateNotify	if true then this listener will be notified of all current entries (marked as new)

Implemented in NetworkTable.

virtual bool ITable::ContainsKey ( std::string  key )

pure virtual

Determines whether the given key is in this table.

Parameters

key	the key to search for

Returns

true if the table as a value assigned to the given key

Implemented in NetworkTable.

virtual bool ITable::ContainsSubTable ( std::string  key )

pure virtual

Determines whether there exists a non-empty subtable for this key in this table.

Parameters

key	the key to search for

Returns

true if there is a subtable with the key which contains at least one key/subtable of its own

Implemented in NetworkTable.

virtual bool ITable::GetBoolean ( std::string  key )

pure virtual

Gets the boolean associated with the given name.

Parameters

key	the key to look up

Returns

the value associated with the given key

Exceptions

TableKeyNotDefinedException

if there is no value associated with the given key

Implemented in NetworkTable.

virtual bool ITable::GetBoolean ( std::string  key, bool  defaultValue  )

pure virtual

Gets the boolean associated with the given name.

Parameters

key	the key to look up
defaultValue	the value to be returned if no value is found

Returns

the value associated with the given key or the given default value if there is no value associated with the key

Implemented in NetworkTable.

virtual double ITable::GetNumber ( std::string  key )

pure virtual

Gets the number associated with the given name.

Parameters

key	the key to look up

Returns

the value associated with the given key

Exceptions

TableKeyNotDefinedException

if there is no value associated with the given key

Implemented in NetworkTable.

virtual double ITable::GetNumber ( std::string  key, double  defaultValue  )

pure virtual

Gets the number associated with the given name.

Parameters

key	the key to look up
defaultValue	the value to be returned if no value is found

Returns

the value associated with the given key or the given default value if there is no value associated with the key

Implemented in NetworkTable.

virtual std::string ITable::GetString ( std::string  key )

pure virtual

Gets the string associated with the given name.

Parameters

key	the key to look up

Returns

the value associated with the given key

Exceptions

TableKeyNotDefinedException

if there is no value associated with the given key

Implemented in NetworkTable.

virtual std::string ITable::GetString ( std::string  key, std::string  defaultValue  )

pure virtual

Gets the string associated with the given name.

Parameters

key	the key to look up
defaultValue	the value to be returned if no value is found

Returns

the value associated with the given key or the given default value if there is no value associated with the key

Implemented in NetworkTable.

virtual ITable* ITable::GetSubTable ( std::string  key )

pure virtual

Gets the subtable in this table for the given name.

Parameters

key	the name of the table relative to this one

Returns

a sub table relative to this one

Implemented in NetworkTable.

virtual EntryValue ITable::GetValue ( std::string  key )

pure virtual

Gets the value associated with a key as an object

Parameters

key	the key of the value to look up

Returns

the value associated with the given key

Exceptions

TableKeyNotDefinedException

if there is no value associated with the given key

Implemented in NetworkTable.

virtual void ITable::PutBoolean ( std::string  key, bool  value  )

pure virtual

Put a boolean in the table

Parameters

key	the key to be assigned to
value	the value that will be assigned

Implemented in NetworkTable.

virtual void ITable::PutNumber ( std::string  key, double  value  )

pure virtual

Put a number in the table

Parameters

key	the key to be assigned to
value	the value that will be assigned

Implemented in NetworkTable.

virtual void ITable::PutString ( std::string  key, std::string  value  )

pure virtual

Put a std::string& in the table

Parameters

key	the key to be assigned to
value	the value that will be assigned

Implemented in NetworkTable.

virtual void ITable::PutValue ( std::string  key, ComplexData &  value  )

pure virtual

Put a value in the table

Parameters

key	the key to be assigned to
value	the value that will be assigned

Exceptions

IllegalArgumentException

when the value is not supported by the table

Implemented in NetworkTable.

virtual void ITable::RemoveTableListener ( ITableListener *  listener )

pure virtual

Remove a listener from receiving table events

Parameters

listener

the listener to be removed

Implemented in NetworkTable.

---

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

• ITable.h