dca_interface  6.3.4
ipr_enum.h
Go to the documentation of this file.
1 /* IBM Source Code */
2 /* (C) Copyright IBM Corp. 2009, 2012 */
3 /* Licensed Materials - Property of IBM */
4 /* US Government Users Restricted Rights - Use duplication or disclosure restricted by GSA Schedule Contract with IBM Corp. */
5 
6 #ifndef IPR_ENUM_H
7 #define IPR_ENUM_H
8 
14 namespace dca_ipr {
15 
16  class iprenum_p;
17 
26  class IprEnum {
27  public:
29  IprEnum();
30  IprEnum( const IprEnum& aEnum );
31  IprEnum& operator = ( const IprEnum& aEnum );
32  virtual ~IprEnum();
34 
41  bool operator == ( const IprEnum& aInst ) const;
42 
49  bool operator != ( const IprEnum& aInst ) const;
50 
56 
63  std::string name( const std::string& localeString = std::string() ) const;
64 
66  PRIVATE_PTR iprenum_p *_p;
67  };
68 
75  extern IprEnum NullIprEnum;
76 }
77 
78 #endif
bool operator==(const IprEnum &aInst) const
Equality operator, returns true if two IprEnum objects refer to the identical item.
int DCA_ENUM_ID_TYPE
Id type for IprEnum class.
Definition: ipr_base.h:21
DCA_ENUM_ID_TYPE id() const
Returns the internal id of the enumerable item.
bool operator!=(const IprEnum &aInst) const
Inequality operator, returns true if two IprEnum objects refer to different internal enum items.
The IprEnum class describes a single enumerable item, for example the Geo Location "Greenland".
Definition: ipr_enum.h:26
std::string name(const std::string &localeString=std::string()) const
Returns the localized (display) name of the enumerable item.
#define PRIVATE_PTR
Type for private pointer implementations, for internal use only.
Definition: base_types.h:83
IprEnum NullIprEnum
Defines a constant unassigned IprEnum you can use for checks. if( myIprEnum == NullIprEnum ) --> myIp...