Matrix Science header
Public Member Functions

ms_wwwentry Class Reference
[Mascot configuration files module]

Represent a single entry in the WWW section of mascot.dat. More...

#include <ms_wwwoptions.hpp>

List of all members.

Public Member Functions

 ms_wwwentry ()
 Default constructor.
 ms_wwwentry (const ms_wwwentry &src)
 Copying constructor.
 ~ms_wwwentry ()
 Destructor.
void copyFrom (const ms_wwwentry *right)
 Can be used to create a copy of another object.
void defaultValues ()
 Initialises the instance with default values.
std::string getHostName () const
 Returns a host name used to retrieve reports from.
std::string getName () const
 Returns the name of the database the entry refers to.
int getParseRule () const
 Returns a parse rule number for the entry that corresponds to one of the parse rules specified in the PARSE section of mascot.dat.
std::string getPath () const
 Returns a path to the executable and parameters.
int getPortNumber () const
 Returns a port number for the host used as the information source.
WWW_TYPE getType () const
 Returns the name of the database the entry refers to.
ms_wwwentryoperator= (const ms_wwwentry &right)
 Assignment operator for C++ client applications.
void setHostName (const char *value)
 Change the host name parameter.
void setName (const char *value)
 Set the database name for the entry.
void setParseRule (const int value)
 Change the parse rule number for the entry.
void setPath (const char *value)
 Change the path.
void setPortNumber (const int value)
 Change the port number.
void setType (const WWW_TYPE value)
 Change the entry type.

Detailed Description

Represent a single entry in the WWW section of mascot.dat.

Instances of this class can be stored in in ms_wwwoptions to represent the whole section. Consult the Mascot manual if you are unsure how to configure an entry. It defines an information source where CGI scripts look for the information needed to compile a results report.


Member Function Documentation

std::string getHostName (  ) const

Returns a host name used to retrieve reports from.

For ms-getseq.exe or a similar local executable, this attribute should contain localhost. The word localhost is used to determine whether the application is a command line executable or a CGI application. If you want to specify a CGI application on the local server, just specify the hostname in some other way, for example 127.0.0.1).

For a remote source, or a local source that will be queried as a CGI application, this should be the hostname.

Default is localhost.

See also:
getPortNumber()
Returns:
host name
std::string getName (  ) const

Returns the name of the database the entry refers to.

Note that database name is case sensitive.

The name should be one of those specified in the Databases section. Every name can be associated with more than one entry in the WWW section as different entry types are supported. In order to retrieve the entry type use getType().

By default this is an empty string.

Returns:
name
Examples:
config_mascotdat.cpp.
int getParseRule (  ) const

Returns a parse rule number for the entry that corresponds to one of the parse rules specified in the PARSE section of mascot.dat.

The index of a rule in the PARSE section that can be used to extract the information required.

Default is -1, which is an invalid rule number.

Returns:
parse rule number
std::string getPath (  ) const

Returns a path to the executable and parameters.

A string containing the path to the executable and parameters, some of which are variables.

By default this is empty.

Returns:
path
int getPortNumber (  ) const

Returns a port number for the host used as the information source.

In most cases it should be left as 80, which is the default value.

See also:
getHostName()
Returns:
port number
WWW_TYPE getType (  ) const

Returns the name of the database the entry refers to.

Several entry types are supported. For the complete list of types, see the enumeration values in WWW_TYPE.

There is no default value for this parameter.

Returns:
type
Examples:
config_mascotdat.cpp.
void setHostName ( const char *  value )

Change the host name parameter.

See getHostName() for more information.

Parameters:
valuenew host name
void setName ( const char *  value )

Set the database name for the entry.

See getName() for more information.

Parameters:
valuenew name
void setParseRule ( const int  value )

Change the parse rule number for the entry.

See getParseRule() for more information.

Parameters:
valuenew parse rule number
void setPath ( const char *  value )

Change the path.

See getPath() for more information.

Parameters:
valuepath
void setPortNumber ( const int  value )

Change the port number.

See getPortNumber() for more information.

Parameters:
valuenew port number
void setType ( const WWW_TYPE  value )

Change the entry type.

See getType() for more information.

Parameters:
valuenew type

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:55