bil::BitFileData Class Reference

Models the contents of a Xilinx bit file. More...

#include <bitfile/BitFileData.hpp>

List of all members.

Public Member Functions
std::string &	sourceFileName ()
	Gets name of bitstream source file.
const std::string &	sourceFileName () const
	Gets read only name of bitstream source file.
std::string &	targetDeviceName ()
	Gets name of bitstream target device.
const std::string &	targetDeviceName () const
	Gets read only name of bitstream target device.
std::string &	creationDate ()
	Gets bitstream creation date.
const std::string &	creationDate () const
	Gets read only bitstream creation date.
std::string &	creationTime ()
	Gets bitstream creation time.
const std::string &	creationTime () const
	Gets read only bitstream creation time.
void	bitstreamWordCount (size_t count)
	Sets number of 32 bit words the raw bitstream contains.
size_t	bitstreamWordCount () const
	Gets number of 32 bit words the raw bitstream contains.
boost::uint32_t *	bitstreamWords ()
	Gets a pointer to the raw bitstream data.
const boost::uint32_t *	bitstreamWords () const
	Gets a read only pointer to the raw bitstream data.
void	clear ()
	Clears all data.

---

Detailed Description

Models the contents of a Xilinx bit file.

It contains meta data (e.g. target device name, creation date, etc.), and the raw bitstream. Note that it does not check the meta data and the raw bitstream contents, it is only a container.

Definition at line 25 of file BitFileData.hpp.

---

Member Function Documentation

std::string & BitFileData::sourceFileName

(

)

Gets name of bitstream source file.

Returns:

Reference to source file name string.

Definition at line 11 of file BitFileData.cpp.

const std::string & BitFileData::sourceFileName

(

)

const

Gets read only name of bitstream source file.

Returns:

Reference to source file name string.

Definition at line 17 of file BitFileData.cpp.

std::string & BitFileData::targetDeviceName

(

)

Gets name of bitstream target device.

Returns:

Reference to target device name string.

Definition at line 23 of file BitFileData.cpp.

const std::string & BitFileData::targetDeviceName

(

)

const

Gets read only name of bitstream target device.

Returns:

Reference to target device name string.

Definition at line 29 of file BitFileData.cpp.

std::string & BitFileData::creationDate

(

)

Gets bitstream creation date.

Returns:

Reference to creation date string.

Definition at line 35 of file BitFileData.cpp.

const std::string & BitFileData::creationDate

(

)

const

Gets read only bitstream creation date.

Returns:

Reference to creation date string.

Definition at line 41 of file BitFileData.cpp.

std::string & BitFileData::creationTime

(

)

Gets bitstream creation time.

Returns:

Reference to creation time string.

Definition at line 47 of file BitFileData.cpp.

const std::string & BitFileData::creationTime

(

)

const

Gets read only bitstream creation time.

Returns:

Reference to creation time string.

Definition at line 53 of file BitFileData.cpp.

void BitFileData::bitstreamWordCount

(

size_t

count

)

Sets number of 32 bit words the raw bitstream contains.

Parameters:

count

New count to set.

Definition at line 59 of file BitFileData.cpp.

size_t BitFileData::bitstreamWordCount

(

)

const

Gets number of 32 bit words the raw bitstream contains.

Returns:

Number of words.

Definition at line 65 of file BitFileData.cpp.

boost::uint32_t * BitFileData::bitstreamWords

(

)

Gets a pointer to the raw bitstream data.

Returns:

Pointer to bitstream raw data, if bitstreamWordCount() > 0; otherwise 0.

Definition at line 71 of file BitFileData.cpp.

const boost::uint32_t * BitFileData::bitstreamWords

(

)

const

Gets a read only pointer to the raw bitstream data.

Returns:

Pointer to bitstream raw data, if bitstreamWordCount() > 0; otherwise 0.

Definition at line 79 of file BitFileData.cpp.

void BitFileData::clear

(

)

Clears all data.

Definition at line 87 of file BitFileData.cpp.

---

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

• bitfile/BitFileData.hpp
• bitfile/BitFileData.cpp