The DictionaryBase class is the base class for the Dictionary class template and intended to be used instead of Dictionary in cases, when the key type and/or value type of a Dictionary instance can't be known at compile time, but only at runtime.
Whenever possible you should use the class template Dictionary instead of DictionaryBase to enable compile time type safety and optimizations that need compile time type identification. However, when for example receiving unknown data over the network at runtime, the type of that data can't be non at compile time. In those cases DictionaryBase instances are used.
DictionaryBase instances only offer read only API: They can't be modified with the exception of replacing the complete instance with the content of another one. No single entries can be added, removed, or changed. Use the Dictionary sub class template for modifiable Dictionary instances.
Please have a look at the Table of Datatypes for a list of types, that are supported as keys and as values.
Please refer to the documentation for put() and getValue() to see how to store and access data in a Dictionary.
- See also
- getValue(), Dictionary
| const nByte * getKeyTypes |
( |
void |
| ) |
const |
|
virtual |
- Returns
- an array, holding the type code for the key type of the Dictionary and type codes for the key types of potential nested Dictionaries.
Only index 0 of the returned array is guaranteed to be valid. The existence of elements at other indices depends on the value of the element in the array returned by getValueTypes() at the previous index in the following way: Only when getValueTypes()[i] == TypeCode::DICTIONARY, then getKeyTypes()[i+1] will be valid.
Type information for nested Dictionaries will be stored like in the following example: Dictionary<int, Dictionary<short, float**>*> This is a Dictionary, with the key type being int and the value type being a 1D array of type Dictionary<short, float**>, so that all values are Dictionaries, which keys are shorts and which values are 2D arrays of float. This function's return value in this example will hold the values TypeCode::INTEGER at index 0 and TypeCode::SHORT at index 1.
The codes returned by this function match the ones, that are stored in member variable "typename" of class template Helpers::ConfirmAllowedKey's specializations. Only the types, for which specializations of that template exist, are valid Dictionary keys.
Reimplemented in Dictionary< EKeyType, EValueType >, Dictionary< nByte, Common::ExitGames::Common::Object >, Dictionary< Common::ExitGames::Common::Object, Common::ExitGames::Common::Object >, and Dictionary< nByte, Common::Object >.
| const nByte * getValueTypes |
( |
void |
| ) |
const |
|
virtual |
- Returns
- an array, holding the type code for the value type of the Dictionary and type codes for the value types of potential nested Dictionaries.
Only index 0 of the returned array is guaranteed to be valid. The existence of elements at other indices depends on the value of the element at the previous index in the following way: Only when getValueTypes()[i] == TypeCode::DICTIONARY, then getValueTypes()[i+1] will be valid.
Type information for nested Dictionaries will be stored like in the following example: Dictionary<int, Dictionary<short, float**>*> This is a Dictionary, with the key type being int and the value type being a 1D array of type Dictionary<short, float**>, so that all values are Dictionaries, which keys are shorts and which values are 2D arrays of float. This function's return value in this example will hold the values TypeCode::DICTIONARY at index 0 and TypeCode::FLOAT at index 1.
The codes returned by this function match the ones, that are stored in member variable "typename" of class template Helpers::ConfirmAllowed's specializations. Only the types, for which specializations of that template exist, are valid Dictionary values.
Reimplemented in Dictionary< EKeyType, EValueType >, Dictionary< nByte, Common::ExitGames::Common::Object >, Dictionary< Common::ExitGames::Common::Object, Common::ExitGames::Common::Object >, and Dictionary< nByte, Common::Object >.
| const unsigned int * getValueDimensions |
( |
void |
| ) |
const |
|
virtual |
- Returns
- an array, holding the amount of array dimensions for the value type of the Dictionary and for the value types of potential nested Dictionaries.
Only index 0 of the returned array is guaranteed to be valid. The existence of elements at other indices depends on the value of the element in the array returned by getValueTypes() at the previous index in the following way: Only when getValueTypes()[i] == TypeCode::DICTIONARY, then getValueDimensions()[i+1] will be valid.
Type information for nested Dictionaries will be stored like in the following example: Dictionary<int, Dictionary<short, float**>*> This is a Dictionary, with the key type being int and the value type being a 1D array of type Dictionary<short, float**>, so that all values are Dictionaries, which keys are shorts and which values are 2D arrays of float. This function's return value in this example will hold the value 1 (for 1D array) at index 0 and 2 (for 2D) at index 1. If a value type is no array, then this functions return value will contain 0 at the corresponding index.
Reimplemented in Dictionary< EKeyType, EValueType >, Dictionary< nByte, Common::ExitGames::Common::Object >, Dictionary< Common::ExitGames::Common::Object, Common::ExitGames::Common::Object >, and Dictionary< nByte, Common::Object >.
Photon C++ Client API
4.1.15.3
Public Member Functions inherited from Base