Named¶

This chapter describes the Named interface.

Most objects in the motion software, for example sensors and actuators, have a Name property that can be retrieved via the API. In most cases the name can also be changed to match the users application, for example, if the sensor interface with default name Enc0 is used to measure the position of the X-axis, the user can opt to rename it to XPosition. After rename the default name remains accessible via the DefaultName property.

INamed.Name

INamed.DefaultName

C++

INamed::GetName()
INamed::SetName()
INamed::GetDefaultName()

For predefined objects, e.g. sensors and actuators, the default name equals the name defined in the product specific documentation. For user created objects, the default name is defined during creation, either using XML configuration or using its creation method on the API, for example the CreateMatrix method on the Controller interface for matrices.

Besides the name and the default name a full name is available. The full name represents the full path from the root system separated by slashes, e.g. 127.0.0.1/Arcas 5EG-0/Cygnus Q3-48-10-2/Enc0/ScaleFactor instead of ScaleFactor.

All names are case sensitive. The following rules apply for changing the name of a named object:

The name must consist of at least 1 and at maximum 64 characters
The name must consist of only characters in the set [a-zA-Z0-9-+ .:_]
The full name must be unique within the system, i.e. all named objects with the same parent must have unique names.

Where possible INamed.Name throws InvalidArgumentException when the name string does not follow the naming rules. However the motion API can not verify uniqueness of controller names within a system due to support for multi-system operation. Violation of the naming rules leads to incorrect behavior when loading an XML configuration file that uses full path names for references.