rss_feed Class Reference
#include <feed.h>
Detailed Description
The
rss_feed class is used to represent an RSS feed.
Is is assumed that the client using this class has confirmed that the project and change passed in are valid and exist.
Definition at line 36 of file feed.h.
Constructor & Destructor Documentation
| virtual rss_feed::~rss_feed |
( |
|
) |
[virtual] |
Constructor.
- Parameters:
-
| the_project | A pointer to a project. |
| the_change | A pointer to a change. |
| the_file | A pointer to the filename associated with this feed. |
| rss_feed::rss_feed |
( |
|
) |
[private] |
The default constructor. Don't use.
| rss_feed::rss_feed |
( |
const rss_feed & |
arg |
) |
[private] |
The copy constructor. Do not use.
Member Function Documentation
| void rss_feed::push_back |
( |
rss_item * |
the_item |
) |
|
Add an item to the RSS feed.
- Parameters:
-
| the_item | The new item to be added to the feed. |
The back method is used to obtain the last item on the list.
The parse method is used to read and parse the RSS feed file into this object. All items read from the file are appended to the feed, via the push_back method. If the file does not exits, this method does nothing.
| void rss_feed::print |
( |
|
) |
const |
The print method is used to print the contents of the feed to the file named in the constructor.
The print method is used to print the contents of the feed to the file named in the constructor.
- Parameters:
-
| void rss_feed::handle_item |
( |
|
) |
|
| void rss_feed::handle_item_title |
( |
const nstring & |
value |
) |
|
| void rss_feed::handle_item_description |
( |
const nstring & |
value |
) |
|
| void rss_feed::handle_item_pub_date |
( |
const nstring & |
value |
) |
|
| void rss_feed::handle_item_link |
( |
const nstring & |
value |
) |
|
| void rss_feed::handle_item_author |
( |
const nstring & |
value |
) |
|
| void rss_feed::handle_item_category |
( |
const nstring & |
value |
) |
|
| void rss_feed::handle_item_comments |
( |
const nstring & |
value |
) |
|
| void rss_feed::handle_item_enclosure |
( |
const nstring & |
value |
) |
|
| void rss_feed::handle_item_guid |
( |
const nstring & |
value, |
|
|
bool |
attr | |
|
) |
| | |
| void rss_feed::handle_item_source |
( |
const nstring & |
value |
) |
|
| size_t rss_feed::size |
( |
|
) |
const [inline] |
| void rss_feed::channel_elements_from_project |
( |
|
) |
|
The channel_elements_from_project method is used to set the channel's descriptive elements from the given project.
| void rss_feed::channel_elements_from_change |
( |
|
) |
|
The channel_elements_from_change method is used to set the craete a new feed item, and set its descriptive elements from the given change.
| void rss_feed::title_set |
( |
const nstring & |
rg |
) |
|
| void rss_feed::description_set |
( |
const nstring & |
rg |
) |
|
The assignment operator. Do not use.
Field Documentation
The project with which this RSS feed is associated.
Definition at line 128 of file feed.h.
The change with which this RSS feed is associated.
Definition at line 133 of file feed.h.
The filename with which this RSS feed is associated.
Definition at line 138 of file feed.h.
The title instance variable is used to remember "The name of the channel. It's how people refer to your service. If you have an HTML website that contains the same information as your RSS file, the title of your channel should be the same as the title of your website."
Definition at line 147 of file feed.h.
The description instance variable is used to remember a "Phrase or sentence describing the channel."
Definition at line 153 of file feed.h.
The language instance variable is used to remember "The language the channel is written in."
Definition at line 159 of file feed.h.
The pub_date instance variable is used to remember "The publication date for the content in the channel. For example, the New York Times publishes on a daily basis, the publication date flips once every 24 hours. That's when the pubDate of the channel changes."
Definition at line 168 of file feed.h.
The last_build_date instance variable is used to remember "The last time the content of the channel changed."
Definition at line 174 of file feed.h.
The generator instance variable is used to remember "A string indicating the program used to generate the channel."
Definition at line 180 of file feed.h.
The docs instance variable is used to remember "A URL that points to the documentation for the format used in the RSS file. It's probably a pointer to this page. It's for people who might stumble across an RSS file on a Web server 25 years from now and wonder what it is."
Definition at line 189 of file feed.h.
The link instance variable is used to remember "The URL to the HTML website corresponding to the channel."
Definition at line 195 of file feed.h.
The documentation for this class was generated from the following file:
