Bitstream Interpretation Library (BIL)  0.1
Public Member Functions | Friends
bil::PrimitiveSite Class Reference

A primitive site. More...

#include <xdlrc/model/PrimitiveSite.hpp>

List of all members.

Public Member Functions

 PrimitiveSite ()
 Constructs a new PrimitiveSite instance.
std::string & name ()
 Gets name.
const std::string & name () const
 Gets name read only.
void isBonded (bool flag)
 Sets bonded/unbonded flag.
bool isBonded () const
 Gets pin bonded/unbonded flag.
void clear ()
 Resets all properties to default values.

Friends

void writeBinary (const PrimitiveSite &data, std::ostream &outputStream)
 Writes data from a PrimitiveSite into a binary stream.
void readBinary (PrimitiveSite &data, std::istream &inputStream)
 Reads data into a PrimitiveSite from a binary stream.

Detailed Description

A primitive site.

The primitive site entity in XDLRC is broken up into two classes: PrimitiveSite and PrimitiveSiteType. The PrimitiveSite stores data of a distinct primitive site on a tile: its name and its bonded flag.

Definition at line 24 of file PrimitiveSite.hpp.


Constructor & Destructor Documentation

PrimitiveSite::PrimitiveSite ( )

Constructs a new PrimitiveSite instance.

Definition at line 11 of file PrimitiveSite.cpp.


Member Function Documentation

std::string & PrimitiveSite::name ( )

Gets name.

Returns:
The name.

Definition at line 19 of file PrimitiveSite.cpp.

const std::string & PrimitiveSite::name ( ) const

Gets name read only.

Returns:
The name.

Definition at line 25 of file PrimitiveSite.cpp.

void PrimitiveSite::isBonded ( bool  flag)

Sets bonded/unbonded flag.

Parameters:
flagFlag denoting if this site connects out of the FPGA.

Definition at line 31 of file PrimitiveSite.cpp.

bool PrimitiveSite::isBonded ( ) const

Gets pin bonded/unbonded flag.

Returns:
Flag denoting if this site connects out of the FPGA.

Definition at line 37 of file PrimitiveSite.cpp.

void PrimitiveSite::clear ( )

Resets all properties to default values.

Definition at line 43 of file PrimitiveSite.cpp.


Friends And Related Function Documentation

void writeBinary ( const PrimitiveSite data,
std::ostream &  outputStream 
)
friend

Writes data from a PrimitiveSite into a binary stream.

Parameters:
dataThe PrimitiveSite to write.
outputStreamThe stream to write into.
Exceptions:
.
void readBinary ( PrimitiveSite data,
std::istream &  inputStream 
)
friend

Reads data into a PrimitiveSite from a binary stream.

Parameters:
dataThe PrimitiveSite to read into.
inputStreamThe stream to read from.
Exceptions:
.

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