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

A primitive type. More...

#include <xdlrc/model/PrimitiveType.hpp>

List of all members.

Public Member Functions

 PrimitiveType ()
 Constructs a new PrimitiveType instance.
std::string & name ()
 Gets type name.
const std::string & name () const
 Gets type name read only.
Pinspins ()
 Gets pins.
const Pinspins () const
 Gets pins read only.
Elementselements ()
 Gets elements.
const Elementselements () const
 Gets elements read only.
void tag (size_t t)
 Gets tag.
size_t tag () const
 Gets tag.
void clear ()
 Resets all properties to default values.

Friends

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

Detailed Description

A primitive type.

Primitives are a basic logic units of a certain type. The PrimitiveType class describes such a type by providing its name, its pins (connecting the primitive to the outside), and its list of elements (making up its configurable parts).

Definition at line 25 of file PrimitiveType.hpp.


Constructor & Destructor Documentation

PrimitiveType::PrimitiveType ( )

Constructs a new PrimitiveType instance.

Definition at line 11 of file PrimitiveType.cpp.


Member Function Documentation

std::string & PrimitiveType::name ( )

Gets type name.

Returns:
The name.

Definition at line 21 of file PrimitiveType.cpp.

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

Gets type name read only.

Returns:
The name.

Definition at line 27 of file PrimitiveType.cpp.

Pins & PrimitiveType::pins ( )

Gets pins.

Returns:
The pins.

Definition at line 33 of file PrimitiveType.cpp.

const Pins & PrimitiveType::pins ( ) const

Gets pins read only.

Returns:
The pins.

Definition at line 39 of file PrimitiveType.cpp.

Elements & PrimitiveType::elements ( )

Gets elements.

Returns:
The elements.

Definition at line 45 of file PrimitiveType.cpp.

const Elements & PrimitiveType::elements ( ) const

Gets elements read only.

Returns:
The elements.

Definition at line 51 of file PrimitiveType.cpp.

void PrimitiveType::tag ( size_t  t)

Gets tag.

Parameters:
tThe tag.

Definition at line 57 of file PrimitiveType.cpp.

size_t PrimitiveType::tag ( ) const

Gets tag.

Returns:
The tag.

Definition at line 63 of file PrimitiveType.cpp.

void PrimitiveType::clear ( )

Resets all properties to default values.

Definition at line 69 of file PrimitiveType.cpp.


Friends And Related Function Documentation

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

Writes data from a PrimitiveType into a binary stream.

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

Reads data into a PrimitiveType from a binary stream.

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

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