MAK RTIspy API Documentation for HLA 1.3: dimInfo.h Source File

Go to the documentation of this file.
00001 /*********************************************************************
00002 ** Copyright (c) 2001 MaK Technologies, Inc.
00003 ** All rights reserved.
00004 *********************************************************************/
00005 /*********************************************************************
00006 ** $RCSfile: dimInfo.h,v $ $Revision: 1.21 $ $State: Exp $
00007 *********************************************************************/
00010 
00011 #ifndef DtDimInfo_H_
00012 #define DtDimInfo_H_
00013 
00014 #ifdef DDM
00015 
00016 #include "rtiMsConfig.h"
00017 #include <vlutil/vlMachineTypes.h>
00018 #include "internalTypes.h"
00019 #include <vlutil/vlString.h>
00020 
00021 #ifdef DtIFSPEC13
00022 #ifdef DtIFSPEC13DLC
00023 #include "RTI13.h"
00024 #define MIN_EXTENT 0 
00025 #define MAX_EXTENT ULONG_MAX 
00026 #else
00027 #include "RTI.hh"
00028 #endif
00029 #endif
00030 
00031 #if defined(DtIFSPEC1516) || defined (DtIFSPEC1516E)
00032 #include <limits.h>
00033 #define MIN_EXTENT 0
00034 #define MAX_EXTENT ULONG_MAX
00035 #endif
00036 
00037 class DtDimInfo;
00038 
00039 class DT_DLL_LRC DtDimInfo
00040 {
00041 public:
00042 
00044    DtDimInfo();
00045    DtDimInfo(const char* dimName, int handle, bool exclude=true,
00046       unsigned long lower=MIN_EXTENT, unsigned long upper=MAX_EXTENT,
00047       unsigned long max=MAX_EXTENT);
00048    DtDimInfo(const DtDimInfo& orig);
00049    
00051    DtDimInfo& operator=(const DtDimInfo& orig);
00052    bool operator!=(const DtDimInfo& orig);
00053    bool operator==(const DtDimInfo& orig);
00054 
00056    virtual ~DtDimInfo();
00057 
00059    virtual void setName(const char* nameValue);
00060    virtual const char* name() const;
00061 
00063    virtual bool isName(const char* name);
00064 
00066    virtual void setHandle(DtDimensionHandle handleValue);
00067    virtual DtDimensionHandle handle() const;
00068 
00070    virtual void setLowerBound(unsigned long lower);
00071    virtual unsigned long lowerBound() const;
00072 
00074    virtual void setUpperBound(unsigned long upper);
00075    virtual unsigned long upperBound() const;
00076 
00078    virtual void setMaxBound(unsigned long max);
00079    virtual unsigned long maxBound() const;
00080 
00082    virtual void setExcluded(bool exclude);
00083    virtual bool excluded() const;
00084 
00086    virtual void print() const;
00087 
00088 protected:
00089 
00090    MAKRti::DtString myName;
00091    DtDimensionHandle myHandle;
00092    unsigned long myMaxBound;
00093    unsigned long myLowerBound;
00094    unsigned long myUpperBound;
00095    bool myExcluded;
00096 };
00097 
00098 inline const char* DtDimInfo::name() const
00099 {
00100    return myName.string();
00101 }
00102 
00103 inline DtDimensionHandle DtDimInfo::handle() const
00104 {
00105    return myHandle;
00106 }
00107 
00108 #endif
00109 #endif
00110 
00111 
00112 
00113 
00114 
00115 
00116