QmcDesc(3) — Linux manual page


QMCDESC(3)              Library Functions Manual              QMCDESC(3)

NAME         top

       QmcDesc - container for a metric description

C++ SYNOPSIS         top

       #include <QmcDesc.h>

       CC ... -lqmc -lpcp

DESCRIPTION         top

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



       QmcDesc(pmID pmid);
           Construct a container for the descriptor for pmid.  The
           descriptor is obtained from the current PMAPI(3) context
           using pmLookupDesc(3).

DESCRIPTION         top

       int status() const;
           A status less than zero indicates that the descriptor could
           not be obtained, the PMAPI(3) error is encoded in the result.

       pmID id() const;
           Return the pmID for this descriptor.

       pmDesc desc() const;
           Return a copy of the actual metric descriptor.

       const pmDesc *descPtr() const;
           Return a pointer to the actual descriptor to avoid using a
           pointer to a temporary.

UNITS         top

       const QString &units() const;
           The complete unit string for this descriptor.

       const QString &abvUnits() const;
           The unit string using abbreviations.

       bool useScaleUnits() const;
           Returns true if the units have been set by a call to

       const pmUnits &scaleUnits() const;
           Return the scaling units for this descriptor.

       void setScaleUnits(const pmUnits &units);
           Set the scaling units for this descriptor.

DIAGNOSTICS         top

       Error messages are generated using pmprintf(3) but are not
       flushed. It is the responsibility of the user to call pmflush(3)
       to output any messages.

       Additional diagnostics may be activated by adding the option pmc
       to the global debugging specification, as described in

SEE ALSO         top

       PMAPI(3), QMC(3), pmflush(3), pmLookupDesc(3) and pmprintf(3).

COLOPHON         top

       This page is part of the PCP (Performance Co-Pilot) project.
       Information about the project can be found at 
       ⟨http://www.pcp.io/⟩.  If you have a bug report for this manual
       page, send it to pcp@groups.io.  This page was obtained from the
       project's upstream Git repository
       ⟨https://github.com/performancecopilot/pcp.git⟩ on 2021-08-27.
       (At that time, the date of the most recent commit that was found
       in the repository was 2021-08-27.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to

Performance Co-Pilot               SGI                        QMCDESC(3)

Pages that refer to this page: QMC(3)QmcContext(3)QmcIndom(3)