dca_interface  6.3.4
ipr_category.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_CATEGORY_H
7 #define IPR_CATEGORY_H
8 
14 namespace dca_ipr {
15 
16  class iprcategory_p;
17 
27  class IprCategory {
28  public:
30  IprCategory();
31  IprCategory( const IprCategory& aCategory );
32  IprCategory& operator = ( const IprCategory& aCategory );
33  virtual ~IprCategory();
35 
42  bool operator == ( const IprCategory& aInst ) const;
43 
50  bool operator != ( const IprCategory& aInst ) const;
51 
57 
64  std::string name( const std::string& localeString = std::string() ) const;
65 
71 
79 
87  DCA_ENUM_ID_TYPE enumByValue( int value ) const;
88 
90  PRIVATE_PTR iprcategory_p *_p;
91  };
92 
100 }
101 
102 #endif
DCA_ENUM_ID_TYPE enumByValue(int value) const
Returns the id of an enum item associated with the current IprCategory.
DCA_SIZE_TYPE enumsSize() const
Returns the count of IprEnum items associated with current IprCategory.
IprCategory NullIprCategory
Defines a constant unassigned IprCategory you can use for checks. if( myIprCategory == NullIprCategor...
int DCA_ENUM_ID_TYPE
Id type for IprEnum class.
Definition: ipr_base.h:21
std::string name(const std::string &localeString=std::string()) const
Returns the localized (display) name of the category.
bool operator==(const IprCategory &aInst) const
Equality operator, returns true if two IprCategory objects refer to the identical internal category.
int DCA_CATEGORY_ID_TYPE
Type for category ids.
Definition: base_types.h:31
DCA_CATEGORY_ID_TYPE id() const
Returns the internal id of a IprCategory class.
size_t DCA_INDEX_TYPE
Type for index access (used for arrays and collections).
Definition: base_types.h:66
size_t DCA_SIZE_TYPE
Type for size (used for size of array and collections).
Definition: base_types.h:72
#define PRIVATE_PTR
Type for private pointer implementations, for internal use only.
Definition: base_types.h:83
bool operator!=(const IprCategory &aInst) const
Inequality operator, returns true if two IprCategory objects refer to different internal categories.
The IprCategory class contains information for a single category. An IP address can be assigned to on...
Definition: ipr_category.h:27
DCA_ENUM_ID_TYPE enumId(DCA_INDEX_TYPE index) const
Returns the id of an enum item associated with the current IprCategory.