TVFileSettings.h

Go to the documentation of this file.

/******************************************************************************
 *
 * A test vector file generator for hardware designs.
 * Copyright (C) 2014 ETHZ Zurich, Integrated Systems Laboratory
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *****************************************************************************/

#ifndef TVFILESETTINGS_H_
#define TVFILESETTINGS_H_

#include <string>
#include <vector>

#include "SignalDeclaration.h"

using namespace std;

class TVFileSettings {

private:
        // **************************************************************************
        // Members
        // **************************************************************************
  string filePath_;             // File name.
  string projectName_;          // Project name the test vector file belongs to.
  string content_;              // Describes the content of the test vector file.
  string author_;               // Author of the test vector file.
  string commentIndicator_;     // String starting a comment.
  string columnIndicator_;      // String indicating the alignment of the signals to their corresponding caption (column).
  int signalDistance_;          // Number of spaces between two testvectors.
  int commentSpaces_;           // Number of spaces between the last signal and the line ending comment (if enabled).
  bool enableLineEndComments_;  // Enable/Disable comments at end of line.
  bool enablePreLineComments_;  // Enable/Disable comments right before line.
  string commentsColumnHeader_; // The string indicating a comment at the end of a line.
  int signalCaptionInterval_;   // The interval after which the signal caption header is printed again.
  char dontCareIdentifier_;                     // The character to be used in order to identify don't care values.

  vector<SignalDeclaration> tvDeclarations_;

public:
  // **************************************************************************
  // Constructors/Destructors
  // **************************************************************************
  TVFileSettings();
  TVFileSettings(string _filePath, string _author, string _content,
      string _projectName);
  TVFileSettings(string _filePath, string _author, string _content,
      string _projectName, const string _commentIndicator,
      const string _columnIndicator, const int _commentSpaces);
  virtual ~TVFileSettings();

  // **************************************************************************
  // Getter/Setter
  // **************************************************************************
  void setFilePath(const string _fileName) { filePath_ = _fileName; };
  void setProjectName(const string _projectName) { projectName_ = _projectName; };
  void setContent(const string _content) { content_ = _content; };
  void setAuthor(const string _author) { author_ = _author; };
  void enableLineEndComments(const bool _enableLineEndComments) {
    enableLineEndComments_ = _enableLineEndComments; };
  void enablePreLineComments(const bool _enablePreLineComments) {
    enablePreLineComments_ = _enablePreLineComments; };
  void setTVDeclarations(const vector<SignalDeclaration> & _tvDeclarations) {
    tvDeclarations_ = _tvDeclarations; };
  string getFilePath() const { return filePath_; };
  string getProjectName() const { return projectName_; };
  string getContent() const { return content_; };
  string getAuthor() const { return author_; };
  string getCommentIndicator() const { return commentIndicator_; };
  string getColumnIndicator() const { return columnIndicator_; };
  int getSignalDistance() const { return signalDistance_; };
  int getCommentSpaces() const { return commentSpaces_; };
  bool isEnableLineEndComments() const { return enableLineEndComments_; };
  bool isEnablePreLineComments() const { return enablePreLineComments_; };
  string getCommentsColumnHeader() const { return commentsColumnHeader_; };
  int getSignalCaptionInterval() const { return signalCaptionInterval_; };
  char getDontCareIdentifier() const { return dontCareIdentifier_; };

  vector<SignalDeclaration> getTVDeclarations() const { return tvDeclarations_; };


  // **************************************************************************
  // Public methods
  // **************************************************************************
  void AddSignal(const SignalDeclaration & _tvDeclaration);

};

#endif /* TVFILESETTINGS_H_ */