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

A programmable interface point. More...

#include <xdlrc/model/PIP.hpp>

List of all members.

Public Member Functions

 PIP ()
 Constructs a new PIP instance.
void startWireIndex (unsigned short index)
 Sets index of start wire.
unsigned short startWireIndex () const
 Gets index of start wire.
void endWireIndex (unsigned short index)
 Sets index of end wire.
unsigned short endWireIndex () const
 Gets index of end wire.
void direction (PIPDirection::direction_t dir)
 Sets direction.
PIPDirection::direction_t direction () const
 Gets direction.
void clear ()
 Resets all properties to default values.

Friends

bool operator== (const PIP &pip1, const PIP &pip2)
 Tests two PIP instances for memberwise equality.
bool operator< (const PIP &pip1, const PIP &pip2)
 Tests two PIP instances for memberwise <.
void writeBinary (const PIP &data, std::ostream &outputStream)
 Writes data from a PIP into a binary stream.
void readBinary (PIP &data, std::istream &inputStream)
 Reads data into a PIP from a binary stream.

Detailed Description

A programmable interface point.

This class describes a programmable interface point, in short PIP. PIPs are located on tiles and represent a connection between a start and an end wire, that can be activated or not by configuration. The direction of the connection can vary. (In an XDLRC file, PIPs that connect an input/output pin pair by connecting the corresponding pin wires are marked as route- through, as they allow routing to go through a primitive site. Since this information is redundant, it is omitted here. Because of similar reasons the location of the PIP is omitted, too.)

Definition at line 29 of file PIP.hpp.


Constructor & Destructor Documentation

PIP::PIP ( )

Constructs a new PIP instance.

Definition at line 11 of file PIP.cpp.


Member Function Documentation

void PIP::startWireIndex ( unsigned short  index)

Sets index of start wire.

Parameters:
indexIndex of wire in superordinated TileType.

Definition at line 20 of file PIP.cpp.

unsigned short PIP::startWireIndex ( ) const

Gets index of start wire.

Returns:
Index of wire in superordinated TileType.

Definition at line 26 of file PIP.cpp.

void PIP::endWireIndex ( unsigned short  index)

Sets index of end wire.

Parameters:
indexIndex of wire in superordinated TileType.

Definition at line 32 of file PIP.cpp.

unsigned short PIP::endWireIndex ( ) const

Gets index of end wire.

Returns:
Index of wire in superordinated TileType.

Definition at line 38 of file PIP.cpp.

void PIP::direction ( PIPDirection::direction_t  dir)

Sets direction.

Parameters:
dirThe new direction.

Definition at line 44 of file PIP.cpp.

PIPDirection::direction_t PIP::direction ( ) const

Gets direction.

Returns:
The direction.

Definition at line 50 of file PIP.cpp.

void PIP::clear ( )

Resets all properties to default values.

Definition at line 56 of file PIP.cpp.


Friends And Related Function Documentation

bool operator== ( const PIP pip1,
const PIP pip2 
)
friend

Tests two PIP instances for memberwise equality.

Definition at line 119 of file PIP.hpp.

bool operator< ( const PIP pip1,
const PIP pip2 
)
friend

Tests two PIP instances for memberwise <.

Definition at line 134 of file PIP.hpp.

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

Writes data from a PIP into a binary stream.

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

Reads data into a PIP from a binary stream.

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

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