|
Isis 3.0 Application Source Code Reference |
Home |
Generic container for Kernel comments. More...
#include <Commentor.h>
Public Member Functions | |
| Commentor () | |
| Constructor w/initialization. | |
| Commentor (const QString &comfile) | |
| Constructor w/caller provided file containing comments. | |
| virtual | ~Commentor () |
| Destructor. | |
| int | size () const |
| Returns full size of current comments internalized. | |
| void | operator() (const K &source) |
| operator() method to collect comments from each segment | |
| void | loadCommentFile (const QString &comFile) |
| Loads general comments from a given file. | |
| void | setCommentHeader (const QString &comment) |
| Allows user to set comment header string. | |
| QString | Comments () const |
| Returns the current contents of the collected comments. | |
| void | Clear () |
| Clear out all comments collected for starting over. | |
Generic container for Kernel comments.
This class provides an accumulator for the comments that are generated for a SPICE kernel. It accepts the comments from a file if provided by the caller or, otherwise they are generated using the default comment for a given SPICE kernel type. Additionally, an operator()(K &source) segment method is provided to collect the comments generated for each segment in a list. This is typically the list that is to be written to an eventual SPICE kernel file.
Definition at line 47 of file Commentor.h.
| Commentor | ( | ) | [inline] |
Constructor w/initialization.
Definition at line 50 of file Commentor.h.
| Commentor | ( | const QString & | comfile | ) | [inline] |
Constructor w/caller provided file containing comments.
Definition at line 52 of file Commentor.h.
| virtual ~Commentor | ( | ) | [inline, virtual] |
Destructor.
Definition at line 60 of file Commentor.h.
| int size | ( | ) | const [inline] |
Returns full size of current comments internalized.
Definition at line 63 of file Commentor.h.
| void operator() | ( | const K & | source | ) | [inline] |
operator() method to collect comments from each segment
This operator method is provided for use in the SpiceKernel class usage whereby each segment is called and the comments are retrieved from each segment when called.
| K | Segment where specific comments are retreived |
Definition at line 74 of file Commentor.h.
| void loadCommentFile | ( | const QString & | comFile | ) | [inline] |
Loads general comments from a given file.
Definition at line 86 of file Commentor.h.
| void setCommentHeader | ( | const QString & | comment | ) | [inline] |
Allows user to set comment header string.
Definition at line 97 of file Commentor.h.
| QString Comments | ( | ) | const [inline] |
Returns the current contents of the collected comments.
Definition at line 103 of file Commentor.h.
| void Clear | ( | ) | [inline] |
Clear out all comments collected for starting over.
Definition at line 108 of file Commentor.h.