Project

General

Profile

Task #363885

rename particle "tag" to "id"

Added by Felix Höfling about 3 years ago. Updated 5 months ago.

Status:
Closed
Priority:
Normal
Assignee:
-
Target version:
Start date:
Due date:
% Done:

100%

Estimated time:

Description

The property "tag" in mdsim.particles should be renamed to "id". An "id" is a unique identifier, while a tag can be anything. This change corresponds to the naming convention in the H5MD format:
http://nongnu.org/h5md/h5md.html#particles-group

Note that the change breaks the Lua API of mdsim.particle:
http://halmd.org/modules/mdsim/particle.html#halmd.mdsim.particle.get_tag
http://halmd.org/modules/mdsim/particle.html#halmd.mdsim.particle.set_tag

It is tempting to replace the functions get_tag() and set_tag(x) by a read-write property "tag" (and similarly for all other properties). Before, we have to check that this does not break anything else, e.g., because get_tag is used as a slot function for output.


Related issues

Related to HAL's MD package - Task #345151: revise and unify access to particle dataClosed

Related to HAL's MD package - Task #281799: stable API of Lua libraryNew2014-03-19

Related to HAL's MD package - Task #281803: revise H5MD readers/writersNew2014-03-19

Associated revisions

Revision 6510 (diff)
Added by daniel.kirchner 11 months ago

particle: rename tag to id

Renames particle tag and reverse_tag to id and reverse_id for conformance
with the H5MD naming convention.

This commit closes #363885.

Revision 6501 (diff)
Added by daniel.kirchner 11 months ago

particle: rename tag to id

Renames particle tag and reverse_tag to id and reverse_id for conformance
with the H5MD naming convention.

This commit closes #363885.

History

#1 Updated by Felix Höfling about 3 years ago

  • Related to Task #345151: revise and unify access to particle data added

#2 Updated by Felix Höfling about 3 years ago

#3 Updated by Felix Höfling about 3 years ago

  • Target version changed from 1.0-alpha to 1.0

#4 Updated by Felix Höfling 12 months ago

  • Related to Task #281803: revise H5MD readers/writers added

#5 Updated by Daniel Kirchner 5 months ago

  • Status changed from New to Closed
  • % Done changed from 0 to 100

Done in commit:7f7b09b9

Also available in: Atom PDF