torc::architecture::PrimitiveElementPin Class Reference

Encapsulation of a primitive element pin's name, flags, and element pointer. Primitive element pins are sub-site inputs or outputs. More...

#include <PrimitiveElementPin.hpp>

Inheritance diagram for torc::architecture::PrimitiveElementPin:

Collaboration diagram for torc::architecture::PrimitiveElementPin:

Public Types
enum	EPinDirection { ePinDirectionNone = 0, ePinDirectionInput = 2, ePinDirectionOutput = 4 }

Public Member Functions
const PrimitiveElement *	getElementPtr (void) const
	Returns a pointer to the primitive element that owns this pin. More...
const string &	getName (void) const
	Returns the pin name. More...
PinFlags	getFlags (void) const
	Returns the pin direction flags. More...
const PrimitiveConnSharedPtr	getPrimitiveConn (void) const
	Returns the primitive connection that includes this pin. More...
	PrimitiveElementPin (void)
	Null constructor. This constructor should only be used by containers. More...
bool	isInput (void) const
	Returns true if this pin is a primitive input. More...
bool	isOutput (void) const
	Returns true if this pin is a primitive output. More...

Protected Types
typedef xilinx::PinFlags	PinFlags
	Imported type name. More...
typedef std::string	string
	Imported type name. More...

Protected Member Functions
	PrimitiveElementPin (const PrimitiveElement *inElementPtr, const std::string &inName, PinFlags inFlags)
	Protected constructor. inElementPtr The primitive element that owns this pin. inName The pin name. inFlags The pin direction flags. More...

Protected Attributes
const PrimitiveElement *	mElementPtr
	The primitive element that owns this pin. More...
string	mName
	The pin name. More...
PinFlags	mFlags
	The pin direction flags. More...
const PrimitiveConnSharedPtr	mPrimitiveConn
	The primitive connection that includes this pin. More...

Friends
class	Sites
	The Sites class has access to our internals. More...
class	torc::architecture::architecture::PrimitiveElementPinUnitTest
	Our unit test class has access to our internals. More...

Detailed Description

Encapsulation of a primitive element pin's name, flags, and element pointer. Primitive element pins are sub-site inputs or outputs.

Definition at line 41 of file PrimitiveElementPin.hpp.

Member Typedef Documentation

typedef xilinx::PinFlags torc::architecture::PrimitiveElementPin::PinFlags

protected

Imported type name.

Definition at line 49 of file PrimitiveElementPin.hpp.

typedef std::string torc::architecture::PrimitiveElementPin::string

protected

Imported type name.

Definition at line 50 of file PrimitiveElementPin.hpp.

Member Enumeration Documentation

enum torc::architecture::PinDirection::EPinDirection

inherited

Enumerator
ePinDirectionNone
ePinDirectionInput
ePinDirectionOutput

Definition at line 37 of file architecture/PrimitivePin.hpp.

                           { ePinDirectionNone = 0, ePinDirectionInput = 2, 
            ePinDirectionOutput = 4 };

Constructor & Destructor Documentation

torc::architecture::PrimitiveElementPin::PrimitiveElementPin ( const PrimitiveElement *  inElementPtr, const std::string &  inName, PinFlags  inFlags  )

inlineprotected

Protected constructor. inElementPtr The primitive element that owns this pin. inName The pin name. inFlags The pin direction flags.

Definition at line 66 of file PrimitiveElementPin.hpp.

                              : mElementPtr(inElementPtr), mName(inName), mFlags(inFlags) {}

torc::architecture::PrimitiveElementPin::PrimitiveElementPin ( void  )

inline

Null constructor. This constructor should only be used by containers.

Definition at line 80 of file PrimitiveElementPin.hpp.

: mElementPtr(0), mName(), mFlags() {};

Member Function Documentation

const PrimitiveElement* torc::architecture::PrimitiveElementPin::getElementPtr ( void  ) const

inline

Returns a pointer to the primitive element that owns this pin.

Definition at line 71 of file PrimitiveElementPin.hpp.

{ return mElementPtr; }

Here is the caller graph for this function:

PinFlags torc::architecture::PrimitiveElementPin::getFlags ( void  ) const

inline

Returns the pin direction flags.

Definition at line 75 of file PrimitiveElementPin.hpp.

{ return mFlags; }

Here is the caller graph for this function:

const string& torc::architecture::PrimitiveElementPin::getName ( void  ) const

inline

Returns the pin name.

Definition at line 73 of file PrimitiveElementPin.hpp.

{ return mName; }

Here is the caller graph for this function:

const PrimitiveConnSharedPtr torc::architecture::PrimitiveElementPin::getPrimitiveConn ( void  ) const

inline

Returns the primitive connection that includes this pin.

Definition at line 77 of file PrimitiveElementPin.hpp.

{ return mPrimitiveConn; }

Here is the caller graph for this function:

bool torc::architecture::PrimitiveElementPin::isInput ( void  ) const

inline

Returns true if this pin is a primitive input.

Definition at line 82 of file PrimitiveElementPin.hpp.

{ return (mFlags & ePinDirectionInput) != 0; }

Here is the caller graph for this function:

bool torc::architecture::PrimitiveElementPin::isOutput ( void  ) const

inline

Returns true if this pin is a primitive output.

Definition at line 84 of file PrimitiveElementPin.hpp.

{ return (mFlags & ePinDirectionOutput) != 0; }

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class Sites

friend

The Sites class has access to our internals.

Definition at line 45 of file PrimitiveElementPin.hpp.

friend class torc::architecture::architecture::PrimitiveElementPinUnitTest

friend

Our unit test class has access to our internals.

Definition at line 47 of file PrimitiveElementPin.hpp.

Field Documentation

const PrimitiveElement* torc::architecture::PrimitiveElementPin::mElementPtr

protected

The primitive element that owns this pin.

Definition at line 53 of file PrimitiveElementPin.hpp.

PinFlags torc::architecture::PrimitiveElementPin::mFlags

protected

The pin direction flags.

See Also

PinDirection.

Definition at line 58 of file PrimitiveElementPin.hpp.

string torc::architecture::PrimitiveElementPin::mName

protected

The pin name.

Definition at line 55 of file PrimitiveElementPin.hpp.

const PrimitiveConnSharedPtr torc::architecture::PrimitiveElementPin::mPrimitiveConn

protected

The primitive connection that includes this pin.

Definition at line 60 of file PrimitiveElementPin.hpp.

---

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

• PrimitiveElementPin.hpp