oaCommonProcInfo.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaCommonProcInfo.h
//
// This file contains the definitions of the ProcInfo class.
//
// ProcInfo
//      A utility class captures the process information and other functions
//      like retrieve the current process information.
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaCommonProcInfo_P)
#define oaCommonProcInfo_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaCommonTypes.h"
#include <string>
#include <limits.h>



// *****************************************************************************
// Declare and define types in the oaCommon namespace
// *****************************************************************************
BEGIN_OA_COMMON_NAMESPACE



#if defined(OA_WINDOWS)
#define oacMaxProcHostNameLen  _MAX_PATH
#else
#define oacMaxProcHostNameLen  PATH_MAX
#endif

#define oacSmallBufferSize  512


// *****************************************************************************
// ProcInfo
// *****************************************************************************
class OA_COMMON_DLL_API ProcInfo {
public:
                            ProcInfo();
                            ProcInfo(const ProcInfo &obj);

    const char              *getHostName() const;
    bool                    isHostNameEmpty() const;
    unsigned long           getId() const;
    time_t                  getTime() const;


    void                    getHostNamePIDString(std::string    &str,
                                                 const char     *seperator) const;

    void                    setThisProcess();

    void                    setHostName(const char *value);
    void                    setId(unsigned long value);
    void                    setTime(time_t value);

    void                    set(const std::string   &hostNameIn,
                                unsigned long       idIn);
    void                    set(const std::string   &str,
                                const char          *seperator);

    bool                    operator==(const ProcInfo &obj) const;

private:
    char                    hostName[oacMaxProcHostNameLen];
    unsigned long           id;
    time_t                  procTime;
};



END_OA_COMMON_NAMESPACE

#endif

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.