scripts::DataBlock Class Reference

#include <DataBlock.h>

Public Member Functions

 DataBlock (const std::string &filename, const std::size_t lineNumber, const std::string &id)
virtual ~DataBlock ()
void setData (const std::string &data)
const std::stringgetData () const
const std::stringgetID () const
const std::stringgetFilename () const
const std::size_t getLineNumber () const

Private Attributes

std::string _data
std::string _filename
std::size_t _lineNumber
std::string _id

Detailed Description

UFO Script data blocks that contains additional information like the filename the the line number in that file.

Definition at line 12 of file DataBlock.h.


Constructor & Destructor Documentation

scripts::DataBlock::DataBlock ( const std::string filename,
const std::size_t  lineNumber,
const std::string id 
)

Constructor that initializes a data block element with its filename and its linenumber

Parameters:
filename The filename the datablock is stored in
lineNumber The linenumber the datablock can be found at in the given file
id unique name of datablock (usually the keyword between the section name and the opening parenthesis)
virtual scripts::DataBlock::~DataBlock (  )  [virtual]

Member Function Documentation

const std::string& scripts::DataBlock::getData (  )  const
Returns:
The data in this block
const std::string& scripts::DataBlock::getFilename (  )  const
const std::string& scripts::DataBlock::getID (  )  const
const std::size_t scripts::DataBlock::getLineNumber (  )  const
void scripts::DataBlock::setData ( const std::string data  ) 
Parameters:
data The data of the block

Field Documentation

Definition at line 17 of file DataBlock.h.

Definition at line 18 of file DataBlock.h.

Definition at line 20 of file DataBlock.h.

std::size_t scripts::DataBlock::_lineNumber [private]

Definition at line 19 of file DataBlock.h.


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

Generated by  doxygen 1.6.2