Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

IDEA::DatabaseOutputFilterReader Class Reference
[PlanServer handle classes]

This class reads input files which define which objects and attributes to show when PslDatabase::print is invoked. More...

#include <DatabaseOutputFilterReader.hh>

List of all members.

Public Methods

 DatabaseOutputFilterReader ()
 Constructor.

virtual ~DatabaseOutputFilterReader ()
 Destructor.

bool readInputFile (PslOutputFilter *filter, const std::string &fileName)
 Reads an input file by the name fileName.


Static Private Attributes

std::string s_CommentChar = "#"
 Keyword used to indicate a line of comment to be ignored.

std::string s_AllChar = "*"
 Keyword used to indicate all of an entity to be included.

std::string s_ExternalWhiteSpaces = " \t\v\f\r\n"
 External white space characters which will be ignored when reading a token (next keyword).

std::string s_InternalWhiteSpaces = " \t"
 Internal white space characters which will be ignored when reading a token (next keyword).

const int s_LineBufferSize = 1024
 Maximum number of characters in one line of input.


Detailed Description

This class reads input files which define which objects and attributes to show when PslDatabase::print is invoked.

DatabaseOutputFilterReader


Constructor & Destructor Documentation

IDEA::DatabaseOutputFilterReader::DatabaseOutputFilterReader  
 

Constructor.

virtual IDEA::DatabaseOutputFilterReader::~DatabaseOutputFilterReader   [inline, virtual]
 

Destructor.


Member Function Documentation

bool IDEA::DatabaseOutputFilterReader::readInputFile PslOutputFilter   filter,
const std::string &    fileName
 

Reads an input file by the name fileName.

Returns -1 in case of an error otherwise returns 0.

The input-file defines line-by-line which objects and attributes should be included.

\Example Example 1:

MICAS MICAS_Actions_SV

Will include the timeline Action_SV of object MICAS in the output.

Example 2:

MICAS *

Will include all the timelines of the object MICAS in the output.

Example 3:

Will include all the timelines of all the objects in the output, i.e. no filtering is needed.

Returns true if file is valid and output needs filtering. False otherwise.


Member Data Documentation

std::string IDEA::DatabaseOutputFilterReader::s_AllChar = "*" [static, private]
 

Keyword used to indicate all of an entity to be included.

std::string IDEA::DatabaseOutputFilterReader::s_CommentChar = "#" [static, private]
 

Keyword used to indicate a line of comment to be ignored.

std::string IDEA::DatabaseOutputFilterReader::s_ExternalWhiteSpaces = " \t\v\f\r\n" [static, private]
 

External white space characters which will be ignored when reading a token (next keyword).

std::string IDEA::DatabaseOutputFilterReader::s_InternalWhiteSpaces = " \t" [static, private]
 

Internal white space characters which will be ignored when reading a token (next keyword).

const int IDEA::DatabaseOutputFilterReader::s_LineBufferSize = 1024 [static, private]
 

Maximum number of characters in one line of input.


Contact information
© IDEA
Generated on Fri Feb 3 17:09:45 2006 for IDEA.