dca_interface  6.3.4
base_group.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 BASE_GROUP_H
7 #define BASE_GROUP_H
8 
15 namespace dca {
16 
17  class group_p;
18 
25  class Group
26  {
27  public:
29  Group();
30  Group( const Group& grp );
31  Group& operator = ( const Group& grp );
32  virtual ~Group();
34 
36  bool operator == ( const Group& aGroup ) const;
37 
39  bool operator != ( const Group& aGroup ) const;
40 
49  std::string name( const std::string& localeString = std::string() ) const;
50 
52  PRIVATE_PTR group_p *_p;
53  };
54 
58  extern Group NullGroup;
59 
60 }
61 
62 #endif
Group NullGroup
Defines a constant un-assigned Group you can use for checks. if( myGroup == NullGroup ) --> myGroup i...
bool operator==(const Group &aGroup) const
Equality operator, returns true if aGroup.id() == this->id().
int DCA_GROUP_ID_TYPE
Type for group ids.
Definition: base_types.h:36
DCA_GROUP_ID_TYPE id() const
Returns the id of the group as defined in the related categories XML schema.
bool operator!=(const Group &aGroup) const
Inequality operator, returns true if aGroup.id() != this->id().
std::string name(const std::string &localeString=std::string()) const
Returns the localized (display) name of the group.
#define PRIVATE_PTR
Type for private pointer implementations, for internal use only.
Definition: base_types.h:83
Encapsulates a group as defined in the related categories XML schema (see Categories XML: Groups).
Definition: base_group.h:26