Bitstream Interpretation Library (BIL)  0.1
Public Member Functions
bil::Instance Class Reference

Defines a XDL instance. More...

#include <xdl/model/Instance.hpp>

List of all members.

Public Member Functions

 Instance ()
 Constructs a new Instance instance.
std::string & name ()
 Gets name.
const std::string & name () const
 Gets name read only.
void primitiveTypeIndex (size_t index)
 Sets primitive type of this Instance.
size_t primitiveTypeIndex () const
 Gets primitive type of this Instance.
void placed (bool placed)
 Sets placement flag.
bool placed () const
 Gets placement flag.
void bonded (bool bonded)
 Sets bonded flag.
bool bonded () const
 Gets bonded flag.
void tileIndex (size_t index)
 Sets tile this Instance is placed on (if it is).
size_t tileIndex () const
 Gets tile this Instance is placed on (if it is).
void primitiveSiteIndex (size_t index)
 Sets primitive site this Instance is placed on (if it is).
size_t primitiveSiteIndex () const
 Gets primitive site this Instance is placed on (if it is).
std::string & attributes ()
 Gets attribute string.
const std::string & attributes () const
 Gets attribute string read only.
void clear ()
 Resets all properties to default values.

Detailed Description

Defines a XDL instance.

A XDL Instance has got an unique name, a primitive type (meaning that this instance can only be placed on primitive sites of that type), and a flag telling if it is already placed or not. If it is placed, two indices tell on which tile and which primitive site. It has also got an attribute string.

Definition at line 26 of file Instance.hpp.


Constructor & Destructor Documentation

Instance::Instance ( )

Constructs a new Instance instance.

Definition at line 11 of file Instance.cpp.


Member Function Documentation

std::string & Instance::name ( )

Gets name.

Returns:
The name.

Definition at line 24 of file Instance.cpp.

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

Gets name read only.

Returns:
The name.

Definition at line 30 of file Instance.cpp.

void Instance::primitiveTypeIndex ( size_t  index)

Sets primitive type of this Instance.

Parameters:
indexIndex of a PrimitiveType in a Device.

Definition at line 36 of file Instance.cpp.

size_t Instance::primitiveTypeIndex ( ) const

Gets primitive type of this Instance.

Returns:
Index of a PrimitiveType in a Device.

Definition at line 42 of file Instance.cpp.

void Instance::placed ( bool  placed)

Sets placement flag.

Parameters:
placedFlag telling if this Instance is placed or not.

Definition at line 48 of file Instance.cpp.

bool Instance::placed ( ) const

Gets placement flag.

Returns:
Flag telling if this Instance is placed or not.

Definition at line 54 of file Instance.cpp.

void Instance::bonded ( bool  bonded)

Sets bonded flag.

Parameters:
bondedFlag telling if this Instance is bonded out or not, when it is not placed.

Definition at line 60 of file Instance.cpp.

bool Instance::bonded ( ) const

Gets bonded flag.

Returns:
Flag telling if this Instance is bonded or not, when it is not placed.

Definition at line 66 of file Instance.cpp.

void Instance::tileIndex ( size_t  index)

Sets tile this Instance is placed on (if it is).

Parameters:
indexIndex of a Tile in a Device.

Definition at line 72 of file Instance.cpp.

size_t Instance::tileIndex ( ) const

Gets tile this Instance is placed on (if it is).

Returns:
Index of a Tile in a Device.

Definition at line 78 of file Instance.cpp.

void Instance::primitiveSiteIndex ( size_t  index)

Sets primitive site this Instance is placed on (if it is).

Parameters:
indexIndex of PrimitiveSite on current Tile.

Definition at line 84 of file Instance.cpp.

size_t Instance::primitiveSiteIndex ( ) const

Gets primitive site this Instance is placed on (if it is).

Returns:
Index of PrimitiveSite on current Tile.

Definition at line 90 of file Instance.cpp.

std::string & Instance::attributes ( )

Gets attribute string.

Returns:
The attribute string.

Definition at line 96 of file Instance.cpp.

const std::string & Instance::attributes ( ) const

Gets attribute string read only.

Returns:
The attribute string.

Definition at line 102 of file Instance.cpp.

void Instance::clear ( )

Resets all properties to default values.

Definition at line 108 of file Instance.cpp.


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