| 1 |
< |
/* |
| 1 |
> |
/* |
| 2 |
|
* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved. |
| 3 |
|
* |
| 4 |
|
* The University of Notre Dame grants you ("Licensee") a |
| 58 |
|
|
| 59 |
|
namespace oopse{ |
| 60 |
|
|
| 61 |
< |
/** |
| 62 |
< |
* @class PropertyMap |
| 63 |
< |
* PropertyMap class maintains a list of GenericData. Type of Property is actually GenericData. |
| 64 |
< |
*/ |
| 65 |
< |
class PropertyMap{ |
| 66 |
< |
public: |
| 61 |
> |
/** |
| 62 |
> |
* @class PropertyMap |
| 63 |
> |
* PropertyMap class maintains a list of GenericData. Type of Property is actually GenericData. |
| 64 |
> |
*/ |
| 65 |
> |
class PropertyMap{ |
| 66 |
> |
public: |
| 67 |
|
|
| 68 |
< |
/** trivial constructor */ |
| 69 |
< |
PropertyMap() {} |
| 68 |
> |
/** trivial constructor */ |
| 69 |
> |
PropertyMap() {} |
| 70 |
|
|
| 71 |
< |
/** |
| 72 |
< |
* Virtual Destructor responsible for deleting all of the generc data in PropertyMap |
| 73 |
< |
*/ |
| 74 |
< |
virtual ~PropertyMap(); |
| 71 |
> |
/** |
| 72 |
> |
* Virtual Destructor responsible for deleting all of the generc data in PropertyMap |
| 73 |
> |
*/ |
| 74 |
> |
virtual ~PropertyMap(); |
| 75 |
|
|
| 76 |
< |
/** |
| 77 |
< |
* Adds property into property map |
| 78 |
< |
* |
| 79 |
< |
* @param genData GenericData to be added into PropertyMap |
| 80 |
< |
* |
| 81 |
< |
* @see #removeProperty |
| 82 |
< |
* @see #clearProperties |
| 83 |
< |
*/ |
| 84 |
< |
void addProperty(GenericData* genData); |
| 76 |
> |
/** |
| 77 |
> |
* Adds property into property map |
| 78 |
> |
* |
| 79 |
> |
* @param genData GenericData to be added into PropertyMap |
| 80 |
> |
* |
| 81 |
> |
* @see #removeProperty |
| 82 |
> |
* @see #clearProperties |
| 83 |
> |
*/ |
| 84 |
> |
void addProperty(GenericData* genData); |
| 85 |
|
|
| 86 |
< |
/** |
| 87 |
< |
* Removes property from PropertyMap by name |
| 88 |
< |
* |
| 89 |
< |
* @param propName the name of property to be removed |
| 90 |
< |
* |
| 91 |
< |
* @see #addProperty |
| 92 |
< |
* @see #clearProperties |
| 93 |
< |
*/ |
| 94 |
< |
bool removeProperty(const std::string& propName); |
| 86 |
> |
/** |
| 87 |
> |
* Removes property from PropertyMap by name |
| 88 |
> |
* |
| 89 |
> |
* @param propName the name of property to be removed |
| 90 |
> |
* |
| 91 |
> |
* @see #addProperty |
| 92 |
> |
* @see #clearProperties |
| 93 |
> |
*/ |
| 94 |
> |
bool removeProperty(const std::string& propName); |
| 95 |
|
|
| 96 |
< |
/** |
| 97 |
< |
* clear all of the properties |
| 98 |
< |
* |
| 99 |
< |
* @see #addProperty |
| 100 |
< |
* @see #removeProperty |
| 101 |
< |
*/ |
| 102 |
< |
void clearProperties(); |
| 96 |
> |
/** |
| 97 |
> |
* clear all of the properties |
| 98 |
> |
* |
| 99 |
> |
* @see #addProperty |
| 100 |
> |
* @see #removeProperty |
| 101 |
> |
*/ |
| 102 |
> |
void clearProperties(); |
| 103 |
|
|
| 104 |
< |
/** |
| 105 |
< |
* Returns all names of properties |
| 106 |
< |
* |
| 107 |
< |
* @return all names of properties |
| 108 |
< |
*/ |
| 109 |
< |
std::vector<std::string> getPropertyNames(); |
| 104 |
> |
/** |
| 105 |
> |
* Returns all names of properties |
| 106 |
> |
* |
| 107 |
> |
* @return all names of properties |
| 108 |
> |
*/ |
| 109 |
> |
std::vector<std::string> getPropertyNames(); |
| 110 |
|
|
| 111 |
< |
/** |
| 112 |
< |
* Returns all of the properties in PropertyMap |
| 113 |
< |
* |
| 114 |
< |
* @return all of the properties in PropertyMap |
| 115 |
< |
* |
| 116 |
< |
* @see #getPropertyByName |
| 117 |
< |
*/ |
| 118 |
< |
std::vector<GenericData*> getProperties(); |
| 111 |
> |
/** |
| 112 |
> |
* Returns all of the properties in PropertyMap |
| 113 |
> |
* |
| 114 |
> |
* @return all of the properties in PropertyMap |
| 115 |
> |
* |
| 116 |
> |
* @see #getPropertyByName |
| 117 |
> |
*/ |
| 118 |
> |
std::vector<GenericData*> getProperties(); |
| 119 |
|
|
| 120 |
< |
/** |
| 121 |
< |
* Returns property |
| 122 |
< |
* |
| 123 |
< |
* @param propName name of property |
| 124 |
< |
* |
| 125 |
< |
* @return a pointer point to property with propName. If no property named propName |
| 126 |
< |
* exists, return NULL |
| 127 |
< |
* |
| 128 |
< |
* @see #getProperties |
| 129 |
< |
*/ |
| 130 |
< |
GenericData* getPropertyByName(const std::string& propName); |
| 131 |
< |
//template<typename T = GenericData*> T getPropertyByName(std:std::string& propName); |
| 120 |
> |
/** |
| 121 |
> |
* Returns property |
| 122 |
> |
* |
| 123 |
> |
* @param propName name of property |
| 124 |
> |
* |
| 125 |
> |
* @return a pointer point to property with propName. If no property named propName |
| 126 |
> |
* exists, return NULL |
| 127 |
> |
* |
| 128 |
> |
* @see #getProperties |
| 129 |
> |
*/ |
| 130 |
> |
GenericData* getPropertyByName(const std::string& propName); |
| 131 |
> |
//template<typename T = GenericData*> T getPropertyByName(std:std::string& propName); |
| 132 |
|
|
| 133 |
< |
protected: |
| 134 |
< |
std::map<std::string, GenericData*> propMap_; |
| 133 |
> |
protected: |
| 134 |
> |
std::map<std::string, GenericData*> propMap_; |
| 135 |
|
|
| 136 |
< |
private: |
| 136 |
> |
private: |
| 137 |
|
|
| 138 |
< |
/** prevent copy constructing */ |
| 139 |
< |
PropertyMap(const PropertyMap&); |
| 138 |
> |
/** prevent copy constructing */ |
| 139 |
> |
PropertyMap(const PropertyMap&); |
| 140 |
|
|
| 141 |
< |
/** prevent copy assignment */ |
| 142 |
< |
PropertyMap& operator=(const PropertyMap&); |
| 143 |
< |
}; |
| 141 |
> |
/** prevent copy assignment */ |
| 142 |
> |
PropertyMap& operator=(const PropertyMap&); |
| 143 |
> |
}; |
| 144 |
|
|
| 145 |
|
}// namespace oopse |
| 146 |
|
|