Matrix Science header
Public Member Functions

ms_mascotfiles Class Reference
[Mascot configuration files module]

An instance of this class contains configuration files paths (except for mascot.dat). More...

#include <ms_mascotfiles.hpp>

Inheritance diagram for ms_mascotfiles:
Inheritance graph
[legend]
Collaboration diagram for ms_mascotfiles:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ms_mascotfiles ()
 Default constructor.
 ms_mascotfiles (const ms_mascotfiles &src)
 Copying constructor.
 ~ms_mascotfiles ()
 Destructor.
void copyFrom (const ms_mascotfiles *right)
 Can be used to create a copy of another object.
void defaultValues ()
 Initialises the instance with default values.
std::string getEnzymes () const
 Returns enzymes path.
std::string getFrequencies () const
 Returns freqs.dat path.
std::string getModifications () const
 Returns mod_file path.
std::string getNodeListFile () const
 Returns nodelist.txt path.
std::string getPreceedingComments () const
 Returns any comments preceeding the section.
ms_mascotfilesoperator= (const ms_mascotfiles &right)
 Assignment operator for C++ client application.
void setEnzymes (const char *filename)
 Change enzymes path.
void setFrequencies (const char *filename)
 Change freqs.dat path.
void setModifications (const char *filename)
 Change mod_file path.
void setNodeListFile (const char *filename)
 Change nodelist.txt path.
void setPreceedingComments (const std::string &comments)
 Sets any comments preceeding the section.

Detailed Description

An instance of this class contains configuration files paths (except for mascot.dat).

An instance of this class is normally created and populated within ms_datfile. It contains filepaths for mod_file, enzymes, frequencies and nodelist.txt.

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

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:
commentsany comments preceeding the section

The documentation for this class was generated from the following files:
Copyright © 2016 Matrix Science Ltd.  All Rights Reserved. Generated on Fri Jun 2 2017 01:44:52