XMM-Newton Science Analysis System


dal (dal-1.187) [xmmsas_20141104_1833-14.0.0]

Meta Index / Home Page / F90 DAL API / API Overview

Attributes

A data set, a block (either array or table), and a column have associated attributes. An attribute is a keyword-value pair, optionally with a string describing the units of the value and a comment. The following procedures can be used to set and enquire attributes:

• $<$type$>$Attribute Returns the value of an attribute of the specified type. Requires a handle to the object and the name of the attribute.
• units Returns a string describing the units of an attribute, given a handle to the object and the name of the attribute.
• label Returns the comment string of an attribute, given a handle to the object and the name of the attribute.
• setAttribute Sets the value of an attribute. In the case of a numeric attribute, requires the handle of the object, the name of the attribute, the value, the units and a comment. For non-numeric attributes the units are not provided.

There is a utility function available to copy attributes from one object to another:

• setAttributes Replaces the attributes by the attributes found in another object. Requires two Attributable handles. A dataset, a block and a column can be converted into an attributable with the attributable call.
• addAttributes Adds the attributes that are found in another object. Requires two Attributable handles. A dataset, a block and a column can be converted into an attributable with the attributable call.
• attribute Return a handle to the attribute with the specified name.
• setAttribute Set an attribute using the result of a previous attribute call.