nitypes.waveform.ExtendedPropertyDictionary

class nitypes.waveform.ExtendedPropertyDictionary(properties: collections.abc.Mapping[str, nitypes.waveform.typing.ExtendedPropertyValue] | None = None, /)

Bases: collections.abc.MutableMapping[str, nitypes.waveform.typing.ExtendedPropertyValue]

A dictionary of extended properties.

Note

Data stored in the extended properties dictionary may not be encrypted when you send it over the network or write it to a TDMS file.

Parameters:

properties (collections.abc.Mapping[str, nitypes.waveform.typing.ExtendedPropertyValue] | None)

__slots__ = ['_properties', '_on_key_changed']
__len__() int

Return len(self).

Return type:

int

__iter__() collections.abc.Iterator[str]

Implement iter(self).

Return type:

collections.abc.Iterator[str]

__contains__(value: object, /) bool

Implement value in self.

Parameters:

value (object)

Return type:

bool

__getitem__(key: str, /) nitypes.waveform.typing.ExtendedPropertyValue

Get self[key].

Parameters:

key (str)

Return type:

nitypes.waveform.typing.ExtendedPropertyValue

__setitem__(key: str, value: nitypes.waveform.typing.ExtendedPropertyValue, /) None

Set self[key] to value.

Parameters:
  • key (str)

  • value (nitypes.waveform.typing.ExtendedPropertyValue)

Return type:

None

__delitem__(key: str, /) None

Delete self[key].

Parameters:

key (str)

Return type:

None

__reduce__() tuple[type[ExtendedPropertyDictionary], tuple[dict[str, nitypes.waveform.typing.ExtendedPropertyValue]]]

Return object state for pickling, excluding the callback.

Return type:

tuple[type[ExtendedPropertyDictionary], tuple[dict[str, nitypes.waveform.typing.ExtendedPropertyValue]]]

__repr__() str

Return repr(self).

Return type:

str

pop(key, default=__marker)

D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised.

popitem()

D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

clear()

D.clear() -> None. Remove all items from D.

update(other=(), /, **kwds)

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F. If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

setdefault(key, default=None)

D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

__abc_tpflags__ = 64
get(key, default=None)

D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

keys()

D.keys() -> a set-like object providing a view on D’s keys

items()

D.items() -> a set-like object providing a view on D’s items

values()

D.values() -> an object providing a view on D’s values

__eq__(other)
__reversed__ = None
classmethod __subclasshook__(C)
__class_getitem__