ArchivableDictionary
References[Serializable]
public class ArchivableDictionary : ICloneable, IDictionary<string, object>, ISerializable
Represents a dictionary class that can be attached to objects and can be serialized (saved) at necessity.
See remarks for layout.
Remarks:
This is the layout of this object:
BEGINCHUNK (TCODE_ANONYMOUS_CHUNK)
|- version (int)
|- entry count (int)
for entry count entries
|- BEGINCHUNK (TCODE_ANONYMOUS_CHUNK)
|- key (string)
|- entry contents
|- ENDCHUNK (TCODE_ANONYMOUS_CHUNK)
ENDCHUNK (TCODE_ANONYMOUS_CHUNK)Constructors
public ArchivableDictionary()
Initializes an instance of a dictionary for writing to a 3dm archive.
Initializes an instance of a dictionary for writing to a 3dm archive.
Parameters:
| version (int) | custom version used to help the plug-in developer determine which version of a dictionary is being written. One good way to write version information is to use a date style integer (YYYYMMDD) |
| name (string) | Optional name to associate with this dictionary. NOTE: if this dictionary is set as a sub-dictionary, the name will be changed to the sub-dictionary key entry |
Initializes an instance of a dictionary for writing to a 3dm archive.
Parameters:
| version (int) | Custom version used to help the plug-in developer determine which version of a dictionary is being written. One good way to write version information is to use a date style integer (YYYYMMDD) |
ArchivableDictionary
#Protected constructor for internal use.
Parameters:
| info (SerializationInfo) | Serialization data. |
| context (StreamingContext) | Serialization stream. |
Properties
Retrieve current change serial number. This is a number that gets increased each time a datum is set or changed.
Gets the number of key/value pairs contained in the dictionary.
Gets or sets the name string of this ArchivableDictionary.
If this dictionary is part of user-data (or is a UserDictionary), then this is the parent user data. null if this dictionary is not part of user-data
Gets or sets the version of this ArchivableDictionary.
Indexers
Parameters:
| key (string) |
this[]
#Gets the value associated with the specified key.
Parameters:
| key (string) | The key of the value to get or set. |
Returns: The value associated with the specified key. If the specified key is not found, a get operation throws a KeyNotFoundException.
Exceptions:
| ArgumentNullException | If the key is null. |
| KeyNotFoundException | If the key is not found. |
Methods
Add the contents from the source dictionary.
Parameters:
| source (ArchivableDictionary) |
Exceptions:
| ArgumentException |
Constructs a deep copy of this object.
Returns: The copy of this object.
Determines whether the dictionary contains the specified key.
Parameters:
| key (string) | The key to locate. |
Returns: true if the dictionary contains an element with the specified key; otherwise, false.
Exceptions:
| ArgumentNullException | key is null. |
Get value as Boolean, will return defaultValue unless value was created using Set(string key, Boolean value)
Get value as Boolean, will only succeed if value was created using Set(string key, Boolean value)
Parameters:
| key (string) |
Get value as byte[], will return defaultValue unless value was created using Set(string key, byte[] value)
Get value as byte[], will only succeed if value was created using Set(string key, byte[] value)
Parameters:
| key (string) |
Get value as ArchivableDictionary, will return defaultValue unless value was created using Set(string key, ArchivableDictionary value)
Parameters:
| key (string) | |
| defaultValue (ArchivableDictionary) |
Get value as ArchivableDictionary, will only succeed if value was created using Set(string key, ArchivableDictionary value)
Parameters:
| key (string) |
Get value as double, will only succeed if value was created using Set(string key, double value)
Get value as double, will only succeed if value was created using Set(string key, double value)
Parameters:
| key (string) |
Gets the enumerator of this dictionary.
Returns: A IEnumerator<T>, where T is an instance of KeyValuePair<T0, T1>, with T0 set as string, and T1 as System.Object.
Get an enum value
Exceptions:
| KeyNotFoundException | Thrown when the key is not found in the dictionary. |
| FormatException | Thrown when the string retrieved from the dictionary is not convertible to the enum type. |
Get an enum value from the dictionary using a custom key.
Parameters:
| key (string) |
Exceptions:
| KeyNotFoundException | Thrown when the key is not found in the dictionary. |
| FormatException | Thrown when the string retrieved from the dictionary is not convertible to the enum type. |
Get value as float, will return defaultValue unless value was created using Set(string key, float value)
Get value as float, will only succeed if value was created using Set(string key, float value)
Parameters:
| key (string) |
Get value as Guid, will return defaultValue unless value was created using Set(string key, Guid value)
Get value as Guid, will only succeed if value was created using Set(string key, Guid value)
Parameters:
| key (string) |
Get value as int, will return defaultValue unless value was created using Set(string key, int value)
Get value as int, will return defaultValue unless value was created using Set(string key, int value)
Get value as int, will only succeed if value was created using Set(string key, int value)
Parameters:
| key (string) |
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
Parameters:
| info (SerializationInfo) | The System.Runtime.Serialization.SerializationInfo to populate with data. |
| context (StreamingContext) | The destination (see System.Runtime.Serialization.StreamingContext) for this serialization. |
Get value as Plane, will return defaultValue unless value was created using Set(string key, Plane value)
Get value as Plane, will return defaultValue unless value was created using Set(string key, Plane value)
Parameters:
| key (string) | The key. |
Returns: The value as Plane.
Get value as Point3d, will return defaultValue unless value was created using Set(string key, Point3d value)
Get value as Point3d, will only succeed if value was created using Set(string key, Point3d value)
Parameters:
| key (string) |
Get value as Point3f, will return defaultValue unless value was created using Set(string key, Point3f value)
Get value as Point3f, will only succeed if value was created using Set(string key, Point3f value)
Parameters:
| key (string) |
Get value as string, will return defaultValue unless value was created using Set(string key, string value)
Get value as string, will only succeed if value was created using Set(string key, string value)
Parameters:
| key (string) | The key which points to the string |
Returns: The string
Get value as Vector3d, will return defaultValue unless value was created using Set(string key, Vector3d value)
Get value as Vector3d, will only succeed if value was created using Set(string key, Vector3d value)
Parameters:
| key (string) |
Removes the value with the specified key from the dictionary.
Parameters:
| key (string) | The key of the element to remove. |
Returns: true if the element is successfully found and removed; otherwise, false. This method returns false if key is not found.
Exceptions:
| ArgumentNullException | Key is null. |
Remove an enum value from the dictionary.
Replace the contents of the dictionary with that of the given source dictionary.
Parameters:
| source (ArchivableDictionary) |
Sets another ArchivableDictionary as entry in this dictionary.
Parameters:
| key (string) | A text key. |
| val (ArchivableDictionary) | An object for that key. Because this class is a reference type and is mutable, changes to this object will propagate to the object inside the dictionary. It is up to the user to clone this entry when appropriate. |
Sets a bool.
Sets a BoundingBox.
Parameters:
| key (string) | A text key. |
| val (BoundingBox) | A value for that key. Because BoundingBox has value semantics, changes to the assigning value will leave this entry unchanged. |
Sets a byte.
Sets a Color.
Sets a double.
Sets a float.
Sets a Font.
Sets any class deriving from the GeometryBase base class.
Parameters:
| key (string) | A text key. |
| val (GeometryBase) | A geometry object for that key. Because this class is a reference type and is mutable, changes to this object will propagate to the object inside the dictionary. It is up to the user to clone this entry when appropriate. You can use GeometryBase.Duplicate() for this. |
Sets a Guid.
Sets a list, an array or any enumerable of bool.
Parameters:
| key (string) | A text key. |
| val (IEnumerable<bool>) | A value for that key. Because this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. It is up to the user to clone this entry when appropriate. |
Returns: true if set operation succeeded, otherwise false.
Sets a list, an array or any enumerable of byte.
Parameters:
| key (string) | A text key. |
| val (IEnumerable<byte>) | A value for that key Because this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. It is up to the user to clone this entry when appropriate. |
Returns: true if set operation succeeded, otherwise false.
Sets a list, an array or any enumerable of double.
Parameters:
| key (string) | A text key. |
| val (IEnumerable<double>) | A value for that key. Because this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. It is up to the user to clone this entry when appropriate. |
Returns: true if set operation succeeded, otherwise false.
Sets a list, an array or any enumerable of float.
Parameters:
| key (string) | A text key. |
| val (IEnumerable<float>) | A value for that key. Because this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. It is up to the user to clone this entry when appropriate. |
Returns: true if set operation succeeded, otherwise false.
Sets an array of GeometryBase
Parameters:
| key (string) | A text key |
| val (IEnumerable<GeometryBase>) | An object for that key Because this class is a reference type and is mutable, changes to this object will propagate to the object inside the dictionary. It is up to the user to clone this entry when appropriate. |
Returns: true if successful, false otherwise.
Sets a list, an array or any enumerable of Guid.
Parameters:
| key (string) | A text key. |
| val (IEnumerable<Guid>) | A value for that key. Because this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. It is up to the user to clone this entry when appropriate. |
Returns: true if set operation succeeded, otherwise false.
Sets a list, an array or any enumerable of int.
Parameters:
| key (string) | A text key. |
| val (IEnumerable<int>) | A value for that key. Because this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. It is up to the user to clone this entry when appropriate. |
Returns: true if set operation succeeded, otherwise false.
Sets an array of ObjRef
Parameters:
| key (string) | A text key |
| val (IEnumerable<ObjRef>) | An object for that key Because this class is a reference type and is mutable, changes to this object will propagate to the object inside the dictionary. It is up to the user to clone this entry when appropriate. |
Sets a list, an array or any enumerable of sbyte.
Parameters:
| key (string) | A text key. |
| val (IEnumerable<sbyte>) | A value for that key. Because this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. It is up to the user to clone this entry when appropriate. |
Returns: true if set operation succeeded, otherwise false.
Sets a list, an array or any enumerable of short.
Parameters:
| key (string) | A text key. |
| val (IEnumerable<short>) | A value for that key. Because this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. It is up to the user to clone this entry when appropriate. |
Returns: true if set operation succeeded, otherwise false.
Sets a list, an array or any enumerable of string.
Parameters:
| key (string) | A text key. |
| val (IEnumerable<string>) | A value for that key. Because this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. It is up to the user to clone this entry when appropriate. |
Returns: true if set operation succeeded, otherwise false.
Sets a int.
Sets an Interval.
Sets a Line.
Sets a long.
Sets a MeshingParameters.
Parameters:
| key (string) | A text key. |
| val (MeshingParameters) | An object for that key. Because this class is a reference type and is mutable, changes to this object will propagate to the object inside the dictionary. It is up to the user to clone this entry when appropriate. |
Sets a ObjRef
Sets a Plane.
Sets a Point.
Sets a Point2d.
Sets a Point3d.
Sets a Point3f.
Sets a Point4d.
Sets a PointF.
Sets a Ray3d.
Sets a Rectangle.
Sets a RectangleF.
Parameters:
| key (string) | A text key. |
| val (RectangleF) | A value for that key. Because RectangleF has value semantics, changes to the assigning value will leave this entry unchanged. |
Sets a sbyte.
Sets a short.
Sets a Size.
Sets a SizeF.
Sets a string.
Sets a Transform.
Sets a uint.
Sets a ushort.
Sets a Vector2d.
Sets a Vector3d.
Sets a Vector3f.
Set an enum value in the dictionary with a custom key.
Parameters:
| key (string) | |
| enumValue (T) |
Set an enum value
Parameters:
| enumValue (T) |
Parameters:
| item (KeyValuePair<string, object>) |
Parameters:
| item (KeyValuePair<string, object>) |
void ICollection<KeyValuePair<string, object>>.CopyTo(KeyValuePair<string, object>[] array, int arrayIndex)
Parameters:
| array (KeyValuePair<string, object>[]) | |
| arrayIndex (int) |
Parameters:
| item (KeyValuePair<string, object>) |
This is not supported and always throws NotSupportedException.
Gets the enumerator of this dictionary.
Returns: A IEnumerator<T>, where T is an instance of KeyValuePair<T0, T1>, with T0 set as string, and T1 as System.Object.
Get value as Boolean, will only succeed if value was created using Set(string key, Boolean value)
Get value as byte[], will only succeed if value was created using Set(string key, byte[] value)
Get value as ArchivableDictionary, will only succeed if value was created using Set(string key, ArchivableDictionary value)
Parameters:
| key (string) | |
| value (out ArchivableDictionary) |
Get value as double, will only succeed if value was created using Set(string key, double value)
Attempt to get an enum value from the dictionary using a custom key.
Parameters:
| key (string) | |
| enumValue (out T) |
Get value as float, will only succeed if value was created using Set(string key, float value)
Get value as Guid, will only succeed if value was created using Set(string key, Guid value)
Get value as int, will only succeed if value was created using Set(string key, int value)
Get value as Plane, will only succeed if value was created using Set(string key, Plane value)
Get value as Point3d, will only succeed if value was created using Set(string key, Point3d value)
Get value as Point3f, will only succeed if value was created using Set(string key, Point3f value)
Get value as string, will only succeed if value was created using Set(string key, string value)
Gets the value associated with the specified key.
Parameters:
| key (string) | The key of the value to get. |
| value (out object) | When this method returns and if the key is found, contains the value associated with the specified key; otherwise, null. This parameter is passed uninitialized. |
Returns: true if the dictionary contains an element with the specified key; otherwise, false.
Exceptions:
| ArgumentNullException | Key is null. |