QmcDesc(3)

1QMCDESC(3)                 Library Functions Manual                 QMCDESC(3)
2
3
4

NAME

6       QmcDesc - container for a metric description
7

C++ SYNOPSIS

9       #include <QmcDesc.h>
10
11       CC ... -lqmc -lpcp
12

DESCRIPTION

14       A  QmcDesc  object  is a container for a metric descriptor (pmDesc, see
15       PMAPI(3)) and units.
16

CONSTRUCTORS & DESTRUCTOR

18       ~QmcDesc();
19           Destructor.
20
21       QmcDesc(pmID pmid);
22           Construct a container for the descriptor for pmid.  The  descriptor
23           is   obtained   from   the   current  PMAPI(3)  context  using  pm‐
24           LookupDesc(3).
25

DESCRIPTION

27       int status() const;
28           A status less than zero indicates that the descriptor could not  be
29           obtained, the PMAPI(3) error is encoded in the result.
30
31       pmID id() const;
32           Return the pmID for this descriptor.
33
34       pmDesc desc() const;
35           Return a copy of the actual metric descriptor.
36
37       const pmDesc *descPtr() const;
38           Return  a pointer to the actual descriptor to avoid using a pointer
39           to a temporary.
40

UNITS

42       const QString &units() const;
43           The complete unit string for this descriptor.
44
45       const QString &abvUnits() const;
46           The unit string using abbreviations.
47
48       bool useScaleUnits() const;
49           Returns true  if  the  units  have  been  set  by  a  call  to  Qm‐
50           cDesc::setScaleUnits.
51
52       const pmUnits &scaleUnits() const;
53           Return the scaling units for this descriptor.
54
55       void setScaleUnits(const pmUnits &units);
56           Set the scaling units for this descriptor.
57

DIAGNOSTICS

59       Error  messages are generated using pmprintf(3) but are not flushed. It
60       is the responsibility of the user to call pmflush(3) to output any mes‐
61       sages.
62
63       Additional diagnostics may be activated by adding the option pmc to the
64       global debugging specification, as described in pmSetDebug(3).
65