torc::architecture::PrimitivePin Class Reference

Encapsulation of a primitive pin's name and flags. Primitive pins are logic site inputs or outputs. More...

#include <PrimitivePin.hpp>

Inheritance diagram for torc::architecture::PrimitivePin:

Collaboration diagram for torc::architecture::PrimitivePin:

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

Public Member Functions
const string &	getName (void) const
	Returns the pin name. More...
PinFlags	getFlags (void) const
	Returns the pin direction flags. More...
	PrimitivePin (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
	PrimitivePin (const string &inName, PinFlags inFlags)
	Protected constructor. inName The pin name. inFlags The pin direction flags. More...

Protected Attributes
string	mName
	The pin name. More...
PinFlags	mFlags
	The pin direction flags. More...

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

Detailed Description

Encapsulation of a primitive pin's name and flags. Primitive pins are logic site inputs or outputs.

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

Member Typedef Documentation

typedef xilinx::PinFlags torc::architecture::PrimitivePin::PinFlags

protected

Imported type name.

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

typedef std::string torc::architecture::PrimitivePin::string

protected

Imported type name.

Definition at line 52 of file architecture/PrimitivePin.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::PrimitivePin::PrimitivePin ( const string &  inName, PinFlags  inFlags  )

inlineprotected

Protected constructor. inName The pin name. inFlags The pin direction flags.

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

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

torc::architecture::PrimitivePin::PrimitivePin ( void  )

inline

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

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

: mName(), mFlags() {};

Member Function Documentation

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

inline

Returns the pin direction flags.

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

{ return mFlags; }

Here is the caller graph for this function:

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

inline

Returns the pin name.

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

{ return mName; }

Here is the caller graph for this function:

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

inline

Returns true if this pin is a primitive input.

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

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

Here is the caller graph for this function:

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

inline

Returns true if this pin is a primitive output.

Definition at line 77 of file architecture/PrimitivePin.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 47 of file architecture/PrimitivePin.hpp.

friend class torc::architecture::architecture::PrimitivePinUnitTest

friend

Our unit test class has access to our internals.

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

Field Documentation

PinFlags torc::architecture::PrimitivePin::mFlags

protected

The pin direction flags.

See Also

PinDirection.

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

string torc::architecture::PrimitivePin::mName

protected

The pin name.

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

---

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

• architecture/PrimitivePin.hpp