ms_unigeneoptions Class Reference [Mascot configuration files module]

An instance of this class represents all the parameters specified in UniGene section of mascot.dat. More...

#include <ms_unigeneoptions.hpp>

Inheritance diagram for ms_unigeneoptions:

Collaboration diagram for ms_unigeneoptions:

List of all members.

Public Member Functions
	ms_unigeneoptions ()
	Default constructor.
	ms_unigeneoptions (const ms_unigeneoptions &src)
	Copying constructor.
virtual	~ms_unigeneoptions ()
	Destructor.
void	copyFrom (const ms_unigeneoptions *right)
	Can be used to create a copy of another object.
virtual void	defaultValues ()
	Initialises the instance with default values.
std::string	getPreceedingComments () const
	Returns any comments preceeding the section.
bool	isSectionAvailable () const
	Indicates whether the section has been actually read from the file.
ms_unigeneoptions &	operator= (const ms_unigeneoptions &right)
	C++ style assignment operator.
void	setPreceedingComments (const std::string &comments)
	Sets any comments preceeding the section.
void	setSectionAvailable (const bool value)
	Changes availability of the section, i.e. should it be saved in a file.

---

Detailed Description

An instance of this class represents all the parameters specified in UniGene section of mascot.dat.

An instance of this class is created and populated in ms_datfile and is available by calling ms_datfile::getUniGeneOptions(). It can also be created separately and initialised with default values. You can create an instance of the class or copy from another instance in order to pass it then as an options-containing object.

For detailed information on any of the options please consult Mascot manual.

Currently, access to the values is only provided through the ms_customproperty class, from which this class is derived. 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.

---

Constructor & Destructor Documentation

ms_unigeneoptions

(

)

Default constructor.

Note:

Not normally called from outside Mascot Parser.

ms_unigeneoptions

(

const ms_unigeneoptions &

src )

Copying constructor.

Note:

Not normally called from outside Mascot Parser.

Parameters:

src	unigene options object

~ms_unigeneoptions

(

)

[virtual]

Destructor.

Note:

Not normally called from outside Mascot Parser.

---

Member Function Documentation

void copyFrom

(

const ms_unigeneoptions *

right )

Can be used to create a copy of another object.

Note:

Not normally called from outside Mascot Parser.

Parameters:

right

is the source to be copied.

void defaultValues

(

)

[virtual]

Initialises the instance with default values.

Note:

Not normally called from outside Mascot Parser.

Reimplemented from ms_customproperty.

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

bool isSectionAvailable

(

)

const

Indicates whether the section has been actually read from the file.

By default the UniGene section is unavailable until it has been set to a different state.

Returns:

true if the section is available.

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

void setSectionAvailable

(

const bool

value )

Changes availability of the section, i.e. should it be saved in a file.

Parameters:

value

should be true to make the section available.

---

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

• ms_unigeneoptions.hpp
• ms_unigeneoptions.cpp