PDG_MemoryInfo.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * COMMENTS:
 */

#ifndef __PDG_MEMORY_INFO_H__
#define __PDG_MEMORY_INFO_H__

#include "PDG_API.h"

#include <SYS/SYS_Types.h>

/**
 * Memory summary information, used either for a single work item or the
 * full set of work items/data structures in a node
 */
struct PDG_API PDG_MemoryInfo
{
    /// Zero-initializes the struct
                    PDG_MemoryInfo()
                        : myAttributeMemory(0)
                        , myGraphMemory(0)
                        , myNodeMemory(0)
                        , myWorkItemMemory(0) {}

    /// The total memory usage
    inline int64    totalMemory() const
                        {
                            return myAttributeMemory +
                                   myGraphMemory + 
                                   myNodeMemory +
                                   myWorkItemMemory;
                        }

    /// The memory usage of the attributes and associated storage
    /// structures for all work items in the query.
    int64           myAttributeMemory;

    /// Memory usage of internal graph structures
    int64           myGraphMemory;

    /// Memory used by internal node sturctures, if this object was queried
    /// from a node
    int64           myNodeMemory;

    /// The total memory usage for all work items in the query.
    int64           myWorkItemMemory;
};

#endif