Matrix Science header
Public Member Functions

ms_parserule Class Reference
[Mascot configuration files module]

Represents a single regular expression parsing rule. More...

#include <ms_parserule.hpp>

List of all members.

Public Member Functions

 ms_parserule ()
 Default constructor.
 ms_parserule (const ms_parserule &src)
 Copying constructor.
 ~ms_parserule ()
 Destructor.
void copyFrom (const ms_parserule *right)
 Copies all contents from another instance.
void defaultValues ()
 Initialises the instance.
std::string getRuleStr () const
 Returns a string representing the rule.
bool isAvailable () const
 Call this member to check if this rule has been specified in the file or just a placeholder.
ms_parseruleoperator= (const ms_parserule &right)
 Assignment operator for C++ client applications.
void setAvailable (const bool value)
 Change the availability of the rule.
void setRuleStr (const char *str)
 Change the rule string.

Detailed Description

Represents a single regular expression parsing rule.

Instances of this class can be stored in ms_parseoptions as a list of parse rules specified in PARSE section of mascot.dat.


Member Function Documentation

bool isAvailable (  ) const

Call this member to check if this rule has been specified in the file or just a placeholder.

Parse rules in the PARSE section are specified in arbitrary order with their unique numbers. There might be gaps and unspecified rules. Therefore, it is recommended to check if the rule is actually available in the file before retrieving its properties.

By default this returns FALSE.

Returns:
true is the rule is available, false otherwise
Examples:
config_mascotdat.cpp.
void setAvailable ( const bool  value )

Change the availability of the rule.

See isAvailable() for more information.

Parameters:
valueboolean whether the rule is available or not

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