bil::Pin Class Reference

A pin of a primitive. More...

#include <xdlrc/model/Pin.hpp>

List of all members.

Public Member Functions
	Pin ()
	Constructs a new Pin instance.
std::string &	externalName ()
	Gets external name.
const std::string &	externalName () const
	Gets external name read only.
void	isInput (bool flag)
	Sets input/output flag.
bool	isInput () const
	Gets pin input/output flag.
void	clear ()
	Resets all properties to default values.

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

---

Detailed Description

A pin of a primitive.

The interface of a primitive is made up by pins connecting the primitive to the outside. Each pin has got an unique name inside its primitive, and is input or output only.

Definition at line 24 of file Pin.hpp.

---

Constructor & Destructor Documentation

Pin::Pin

(

)

Constructs a new Pin instance.

Definition at line 11 of file Pin.cpp.

---

Member Function Documentation

std::string & Pin::externalName

(

)

Gets external name.

Returns:

The name.

Definition at line 19 of file Pin.cpp.

const std::string & Pin::externalName

(

)

const

Gets external name read only.

Returns:

The name.

Definition at line 25 of file Pin.cpp.

void Pin::isInput

(

bool

flag

)

Sets input/output flag.

Parameters:

flag	Flag denoting if this is an input pin.

Definition at line 31 of file Pin.cpp.

bool Pin::isInput

(

)

const

Gets pin input/output flag.

Returns:

Flag denoting if this is an input pin.

Definition at line 37 of file Pin.cpp.

void Pin::clear

(

)

Resets all properties to default values.

Definition at line 43 of file Pin.cpp.

---

Friends And Related Function Documentation

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

friend

Writes data from a Pin into a binary stream.

Parameters:

data	The Pin to write.
outputStream	The stream to write into.

Exceptions:

.

void readBinary ( Pin &  data, std::istream &  inputStream  )

friend

Reads data into a Pin from a binary stream.

Parameters:

data	The Pin to read into.
inputStream	The stream to read from.

Exceptions:

.

---

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

• xdlrc/model/Pin.hpp
• xdlrc/model/Pin.cpp