oaParam.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaParam.h
//
// This file contains the definitions for the oaParam, oaParamType, and
// oaParamArray classes.
//
// *****************************************************************************
// 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(oaParam_P)
#define oaParam_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaString.h"
#include "oaArray.h"



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE



// *****************************************************************************
// oaParamTypeEnum
// *****************************************************************************
#define oavNumParamTypes    7

enum oaParamTypeEnum {
    oacIntParamType     = 0,
    oacFloatParamType   = 1,
    oacStringParamType  = 2,
    oacAppParamType     = 3,
    oacDoubleParamType  = 4,
    oacBooleanParamType = 5,
    oacTimeParamType    = 6
};



// *****************************************************************************
// oaParamType
// *****************************************************************************
class OA_BASE_DLL_API oaParamType {
public:
                            oaParamType(oaParamTypeEnum typeIn);
                            oaParamType(const oaString &name);
                            ~oaParamType();

    const oaString          &getName() const;

                            operator                oaParamTypeEnum() const;

private:
    oaParamTypeEnum         type;

    static const oaString   names[];
};



// *****************************************************************************
// oaParam
// *****************************************************************************
class OA_BASE_DLL_API oaParam {
public:
                            oaParam();
                            oaParam(const oaParam &param);
                            oaParam(const oaString  &nameIn,
                                    oaInt4          value);
                            oaParam(const oaString  &nameIn,
                                    oaFloat         value);
                            oaParam(const oaString  &nameIn,
                                    const oaString  &value);
                            oaParam(const oaString  &nameIn,
                                    oaDouble        value);
                            oaParam(const oaString  &nameIn,
                                    const oaString  &appTypeIn,
                                    oaUInt4         numBytesIn,
                                    const oaByte    *byteDataIn);

                            ~oaParam();

    void                    getName(oaString &name) const;
    oaParamType             getType() const;
    oaInt4                  getIntVal() const;
    oaFloat                 getFloatVal() const;
    const oaChar            *getStringVal() const;
    oaDouble                getDoubleVal() const;
    oaBoolean               getBooleanVal() const;
    oaTime                  getTimeVal() const;
    void                    getStringVal(oaString &value) const;
    void                    getAppVal(oaByte *byteData) const;
    oaUInt4                 getNumBytes() const;
    void                    getAppType(oaString &value) const;

    void                    setAppType(const oaChar *value);
    void                    setAppVal(oaUInt4       numBytes,
                                      const oaByte  *byteData);
    void                    setName(const oaChar *nameIn);
    void                    setIntVal(oaInt4 value);
    void                    setFloatVal(oaFloat value);
    void                    setStringVal(const oaChar *value);
    void                    setDoubleVal(oaDouble value);
    void                    setBooleanVal(oaBoolean value);
    void                    setTimeVal(oaTime value);

    oaParam                 &operator=(const oaParam &param);

    oaBoolean               operator==(const oaParam &p) const;
    oaBoolean               operator!=(const oaParam &p) const;

private:
    union {
        oaInt4              intVal;
        oaFloat             floatVal;
        oaChar              *strVal;
        oaDouble            doubleVal;
        oaBoolean           booleanVal;
        oaTime              timeVal;
        oaByte              *byteDataVal;
    };
    oaString                name;
    oaParamType             type;
    oaChar                  *appType;
    oaUInt4                 numBytes;

    friend class oaParamArray;
    friend class oaParamTbl;
    friend class oaIntParamTbl;
    friend class oaStringParamTbl;
    friend class oaFloatParamTbl;
    friend class oaDoubleParamTbl;
    friend class oaBooleanParamTbl;
    friend class oaTimeParamTbl;
    friend class oaAppParamTbl;
};



// *****************************************************************************
// oaParamArray
// *****************************************************************************
class OA_BASE_DLL_API oaParamArray : public oaArray<oaParam> {
public:
                            oaParamArray(oaUInt4 sizeIn = 0);
                            oaParamArray(const oaParamArray &paramsIn);

    oaUInt4                 find(const oaParam &param) const;
    oaBoolean               find(const oaString &name,
                                 oaParam        &param) const;

    virtual oaBoolean       operator==(const oaArray<oaParam> &p) const;
};



END_OA_NAMESPACE

#endif

Return to top of page

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