ms_taxonomychoice Class Reference [Mascot configuration files module]

The class represents a single taxonomy choice entry in the taxonomy file. More...

#include <ms_taxonomyfile.hpp>

Inheritance diagram for ms_taxonomychoice:

Collaboration diagram for ms_taxonomychoice:

List of all members.

Public Member Functions
	ms_taxonomychoice ()
	Default constructor.
	ms_taxonomychoice (const ms_taxonomychoice &src)
	Copying constructor.
	~ms_taxonomychoice ()
	Destructor.
void	appendExcludeTaxonomy (const int id)
	Adds one more taxonomy ID to the exclude list.
void	appendIncludeTaxonomy (const int id)
	Adds one more taxonomy ID to the include list.
void	clearExcludeTaxonomies ()
	Deletes all taxonomy IDs from the exclude list.
void	clearIncludeTaxonomies ()
	Deletes all taxonomy IDs from the include list.
void	copyFrom (const ms_taxonomychoice *src)
	Copies modification configuration from another instance.
void	defaultValues ()
	Re-initialises the object.
int	getExcludeTaxonomy (const int n) const
	Traverse the excluded taxonomy IDs.
int	getIncludeTaxonomy (const int n) const
	Traverse the included taxonomy IDs.
int	getNumberOfExcludeTaxonomies () const
	Returns a total number of excluded taxonomy IDs.
int	getNumberOfIncludeTaxonomies () const
	Returns a total number of included taxonomy IDs.
std::string	getPreceedingComments () const
	Returns any comments preceeding the section.
std::string	getTitle () const
	Returns the taxonomy choice title.
ms_taxonomychoice &	operator= (const ms_taxonomychoice &right)
	C++ style assignment operator.
void	setPreceedingComments (const std::string &comments)
	Sets any comments preceeding the section.
void	setTitle (const char *value)
	Change the title for taxonomy choice.

---

Detailed Description

The class represents a single taxonomy choice entry in the taxonomy file.

Also get yourselves acquainted with the base class ms_customproperty. It facilitates the following tasks:

• Retrieving an unsupported property.
• Retrieving a raw/text/XML property representation.
• Checking for existence of a certain property rather than dealing with its default value.
• Accessing commented lines in a section.

More functionality is described in the documentation for ms_customproperty.

---

Member Function Documentation

std::string getPreceedingComments

(

)

const [inherited]

Returns any comments preceeding the section.

Sections in the mascot.dat file may have comments preceeding them. In most cases, these comments need to stay 'attached' to the section.

Multiple line comments are supported by having a single string with newline characters

See also:

setPreceedingComments()

Returns:

any comments preceeding the section

void setPreceedingComments

(

const std::string &

comments )

[inherited]

Sets any comments preceeding the section.

Sections in the mascot.dat file may have comments preceeding them. In most cases, these comments need to stay 'attached' to the section.

Multiple line comments are supported by having a single string with newline characters

See also:

getPreceedingComments()

Parameters:

comments

any comments preceeding the section

---

The documentation for this class was generated from the following files:

• ms_taxonomyfile.hpp
• ms_taxonomyfile.cpp