TVFileSettings Class Reference

Test vector file settings. More...

#include <TVFileSettings.h>

Public Member Functions
	TVFileSettings ()
	Default constructor. More...
	TVFileSettings (string _filePath, string _author, string _content, string _projectName)
	Constructor, which allows to set several parameters of the test vector file settings. More...
	TVFileSettings (string _filePath, string _author, string _content, string _projectName, const string _commentIndicator, const string _columnIndicator, const int _commentSpaces)
virtual	~TVFileSettings ()
	Destructor.
void	setFilePath (const string _fileName)
void	setProjectName (const string _projectName)
void	setContent (const string _content)
void	setAuthor (const string _author)
void	enableLineEndComments (const bool _enableLineEndComments)
void	enablePreLineComments (const bool _enablePreLineComments)
void	setTVDeclarations (const vector< SignalDeclaration > &_tvDeclarations)
string	getFilePath () const
string	getProjectName () const
string	getContent () const
string	getAuthor () const
string	getCommentIndicator () const
string	getColumnIndicator () const
int	getSignalDistance () const
int	getCommentSpaces () const
bool	isEnableLineEndComments () const
bool	isEnablePreLineComments () const
string	getCommentsColumnHeader () const
int	getSignalCaptionInterval () const
char	getDontCareIdentifier () const
vector< SignalDeclaration >	getTVDeclarations () const
void	AddSignal (const SignalDeclaration &_tvDeclaration)
	Add another signal to the test vector line by providing its signal declaration. More...

Detailed Description

Test vector file settings.

Author

Michael Muehlberghuber (mbgh,michmueh)

Date

21 August 2014

Version

0.1

Constructor & Destructor Documentation

TVFileSettings::TVFileSettings

(

)

Default constructor.

The default constructor sets the comment-indicating character to '', adds a single space before a line ending comment and also enables the line ending comments.

TVFileSettings::TVFileSettings	(	string	_filePath,
		string	_author,
		string	_content,
		string	_projectName
	)

Constructor, which allows to set several parameters of the test vector file settings.

Parameters

_filePath	The path where to store the test vector file.
_author	Name of the author generating the test vector file.
_content	The actual content of the test vector file.
_projectName	Name of the project the test vector will be used for.

TVFileSettings::TVFileSettings	(	string	_filePath,
		string	_author,
		string	_content,
		string	_projectName,
		const string	_commentIndicator,
		const string	_columnIndicator,
		const int	_commentSpaces
	)

Parameters

_filePath	The path where to store the test vector file.
_author	Name of the author generating the test vector file.
_content	The actual content of the test vector file.
_projectName	Name of the project the test vector will be used for.
_commentIndicator	The character to be used to indicate that a comment starts.
_commentSpaces	Number of spaces before the line ending comment.

Member Function Documentation

void TVFileSettings::AddSignal

(

const SignalDeclaration &

_sigDeclaration

)

Add another signal to the test vector line by providing its signal declaration.

Parameters

_sigDeclaration

The signal declaration of the signal to be added to the test vector.

---

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

• /home/michmueh/repos/git/tvgenerator/include/TVFileSettings.h
• /home/michmueh/repos/git/tvgenerator/src/TVFileSettings.cpp