Project

General

Profile

Task #363885

rename particle "tag" to "id"

Added by Felix Höfling over 2 years ago. Updated over 2 years ago.

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

0%


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 data Closed
Related to HAL's MD package - Task #281799: stable API of Lua library New 2014-03-19
Related to HAL's MD package - Task #281803: revise H5MD readers/writers New 2014-03-19

History

#1 Updated by Felix Höfling over 2 years ago

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

#2 Updated by Felix Höfling over 2 years ago

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

  • Target version changed from 1.0-alpha to 1.0

#4 Updated by Felix Höfling 4 months ago

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

Also available in: Atom PDF