torc::generic::Commentable Class Reference
Represents all classes that can hold user comments. More...
#include <Commentable.hpp>
Inheritance diagram for torc::generic::Commentable:
Public Member Functions | |
| void | addComment (const std::string &comment) throw () |
| const std::vector< std::string > & | getComments () const throw () |
| void | setComments (const std::vector< std::string > &inSource) throw () |
Private Member Functions | |
| Commentable (const Commentable &source) throw () | |
| Commentable & | operator= (const Commentable &source) throw () |
Private Attributes | |
| std::vector< std::string > | mComments |
Detailed Description
Represents all classes that can hold user comments.The Commentable class holds a list of user comments that the users can modify. This class is inherited by all classes that can hold comments by user. Comments can be programatically inserted by clients or can be specified in edif files by (comment "string1" ..) syntax.
Definition at line 38 of file Commentable.hpp.
Member Function Documentation
| void torc::generic::Commentable::addComment | ( | const std::string & | comment | ) | throw () |
Add a comment to the object
- Parameters:
-
[in] comment The comment to add to an existing list of comments
Definition at line 40 of file Commentable.cpp.
| const std::vector< std::string > & torc::generic::Commentable::getComments | ( | ) | const throw () [inline] |
Get the list of all comments
- Returns:
- A list of all comments on this object
Definition at line 99 of file Commentable.hpp.
| void torc::generic::Commentable::setComments | ( | const std::vector< std::string > & | inSource | ) | throw () |
Get the list of all comments
- Parameters:
-
[in] inSource A list of all comments to be set on this object
Definition at line 49 of file Commentable.cpp.
The documentation for this class was generated from the following files:
- torc/generic/om/Commentable.hpp
- torc/generic/om/Commentable.cpp
