oaStringProp.h

Go to the documentation of this file.
00001 // *****************************************************************************
00002 // *****************************************************************************
00003 // oaStringProp.h
00004 //
00005 // This file contains the definitions for the oaStringProp class. This class
00006 // implements a string-type property.
00007 //
00008 // *****************************************************************************
00009 // Except as specified in the OpenAccess terms of use of Cadence or Silicon
00010 // Integration Initiative, this material may not be copied, modified,
00011 // re-published, uploaded, executed, or distributed in any way, in any medium,
00012 // in whole or in part, without prior written permission from Cadence.
00013 //
00014 //                Copyright 2002-2005 Cadence Design Systems, Inc.
00015 //                           All Rights Reserved.
00016 //
00017 //  $Author: icftcm $
00018 //  $Revision: #1 $
00019 //  $Date: 2010/08/09 $
00020 //  $State: Exp $
00021 // *****************************************************************************
00022 // *****************************************************************************
00023 
00024 
00025 
00026 #if !defined(oaStringProp_P)
00027 #define oaStringProp_P
00028 
00029 
00030 
00031 // *****************************************************************************
00032 // Nested includes
00033 // *****************************************************************************
00034 #include "oaProp.h"
00035 
00036 
00037 
00038 // *****************************************************************************
00039 // Declare and define types in the OpenAccess namespace.
00040 // *****************************************************************************
00041 BEGIN_OA_NAMESPACE
00042 
00043 
00044 
00045 // *****************************************************************************
00046 // oaStringProp
00047 // *****************************************************************************
00048 class OA_BASE_DLL_API oaStringProp : public oaProp {
00049 public:
00050     static oaStringProp     *create(oaObject        *object,
00051                                     const oaString  &name,
00052                                     const oaString  &value);
00053 
00054     void                    getValue(oaString &value) const;
00055 
00056     void                    setValue(const oaString &value);
00057 };
00058 
00059 
00060 
00061 // *****************************************************************************
00062 // Traits
00063 // *****************************************************************************
00064 template<>
00065 class oaTraits<oaStringProp> {
00066 public:
00067     typedef oaPropModTypeEnum   modTypeType;
00068     typedef oaProp              parentType;
00069     enum {dtIndex = oacBasePropDataType};
00070     enum {dataTypeEnumVal = oacBasePropDataType};
00071     enum {domain = oacNoDomain};
00072     enum {isMultiDomain = false};
00073     enum {dbType = oacBaseDBType};
00074     enum {isConcrete = true};
00075     enum {objectTypeEnumVal = oacStringPropType};
00076 };
00077 
00078 
00079 
00080 END_OA_NAMESPACE
00081 
00082 #endif

Return to top of page