QmcDesc - container for a metric description
Contents
C++ Synopsis
#include<QmcDesc.h>c++...-lpcp_qmc-lpcp
Constructors & Destructor
~QmcDesc();
Destructor.
QmcDesc(pmIDpmid);
Construct a container for the descriptor for pmid. The descriptor is obtained from the current
PMAPI(3) context using pmLookupDesc(3).
Description
intstatus()const;
A status less than zero indicates that the descriptor could not be obtained, the PMAPI(3) error is
encoded in the result.
pmIDid()const;
Return the pmID for this descriptor.
pmDescdesc()const;
Return a copy of the actual metric descriptor.
constpmDesc*descPtr()const;
Return a pointer to the actual descriptor to avoid using a pointer to a temporary.
Diagnostics
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 pmSetDebug(3).
Name
QmcDesc - container for a metric description
See Also
PMAPI(3), QMC(3), pmflush(3), pmLookupDesc(3) and pmprintf(3). Performance Co-Pilot SGI QMCDESC(3)
Units
constQString&units()const;
The complete unit string for this descriptor.
constQString&shortUnits()const;
The unit string using abbreviations.
booluseScaleUnits()const;
Returns true if the units have been set by a call to QmcDesc::setScaleUnits.
constpmUnits&scaleUnits()const;
Return the scaling units for this descriptor.
voidsetScaleUnits(constpmUnits&units);
Set the scaling units for this descriptor.
