Pip routethrough. More...

#include <Routethrough.hpp>

Inheritance diagram for torc::physical::Routethrough:

Collaboration diagram for torc::physical::Routethrough:

Public Member Functions
	Routethrough (const string &inSetting, const string &inName, const string &inValue, const InstanceWeakPtr &inInstancePtr, const string &inSourceWireName, const string &inSinkWireName)
	Public constructor. More...

const string &	getSetting (void) const
	Returns the _ROUTETHROUGH setting. More...

const InstanceWeakPtr &	getInstancePtr (void) const
	Returns the instance weak pointer. More...

const WireName &	getSourceWireName (void) const
	Returns the instance source wire name. More...

const WireName &	getSinkWireName (void) const
	Returns the instance sink wire name. More...

const string &	getValue (void) const
	Return the configuration value. More...

SequenceIndex	getOrder (void) const
	Return the configuration sequence index. More...

void	setValue (const string &inValue)
	Set the configuration value. More...

void	setName (const string &inName)
	Sets the object name. More...

bool	operator== (const Config &rhs) const
	Comparison operator. More...

bool	operator== (const Named &rhs) const
	Equality operator. More...

const string &	getName (void) const
	Returns the object name. More...

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

Protected Member Functions
void	setOrder (SequenceIndex inOrder)
	Set the sequence index for this configuration. More...

Protected Attributes
string	mSetting
	The _ROUTETHROUGH setting in the associated instance. More...

InstanceWeakPtr	mInstancePtr
	The instance in which the routethrough is implemented. More...

WireName	mSourceWireName
	The routethrough instance source wire. More...

WireName	mSinkWireName
	The routethrough instance sink wire. More...

string	mValue
	The configuration setting value. More...

SequenceIndex	mOrder
	The sequence in which the configuration was created. More...

string	mName
	The name of the object. More...

Static Protected Attributes
static const char *	sConfigDefaultName = ""
	Default configuration name. More...

static const char *	sConfigDefaultValue = "#OFF"
	Default configuration value. More...

Detailed Description

Pip routethrough.

A routethrough defines how a signal passes through logic resources on its way to wiring resources.

Definition at line 32 of file Routethrough.hpp.

Member Typedef Documentation

typedef std::string torc::physical::Routethrough::string

protected

Imported type name.

Definition at line 36 of file Routethrough.hpp.

Constructor & Destructor Documentation

torc::physical::Routethrough::Routethrough	(	const string &	inSetting,
		const string &	inName,
		const string &	inValue,
		const InstanceWeakPtr &	inInstancePtr,
		const string &	inSourceWireName,
		const string &	inSinkWireName
	)

inline

Public constructor.

Parameters

inSetting	The _ROUTETHROUGH setting in the associated instance.
inName	The _ROUTETHROUGH name in the associated instance.
inValue	The _ROUTETHROUGH value in the associated instance.
inInstancePtr	The instance weak pointer.
inSourceWireName	The instance source wire name.
inSinkWireName	The instance sink wire name.

Definition at line 55 of file Routethrough.hpp.

58 : Config(inName, inValue), mSetting(inSetting), mInstancePtr(inInstancePtr),

59 mSourceWireName(inSourceWireName), mSinkWireName(inSinkWireName) {}

torc::physical::Routethrough::mSourceWireName

WireName mSourceWireName

The routethrough instance source wire.

Definition: Routethrough.hpp:43

torc::physical::Routethrough::mSetting

string mSetting

The _ROUTETHROUGH setting in the associated instance.

Definition: Routethrough.hpp:39

torc::physical::Routethrough::mInstancePtr

InstanceWeakPtr mInstancePtr

The instance in which the routethrough is implemented.

Definition: Routethrough.hpp:41

torc::physical::Config::Config

Config(void)

Null constructor required by collections.

Definition: Config.hpp:77

torc::physical::Routethrough::mSinkWireName

WireName mSinkWireName

The routethrough instance sink wire.

Definition: Routethrough.hpp:45

Member Function Documentation

const InstanceWeakPtr& torc::physical::Routethrough::getInstancePtr ( void ) const

inline

Returns the instance weak pointer.

Definition at line 64 of file Routethrough.hpp.

64 { return mInstancePtr; }

torc::physical::Routethrough::mInstancePtr

InstanceWeakPtr mInstancePtr

The instance in which the routethrough is implemented.

Definition: Routethrough.hpp:41

Here is the caller graph for this function:

const string& torc::physical::Named::getName ( void ) const

inlineinherited

Returns the object name.

Definition at line 51 of file Named.hpp.

51 { return mName; }

torc::physical::Named::mName

string mName

The name of the object.

Definition: Named.hpp:43

Here is the caller graph for this function:

SequenceIndex torc::physical::Config::getOrder ( void ) const

inlineinherited

Return the configuration sequence index.

Definition at line 88 of file Config.hpp.

88 { return mOrder; }

torc::physical::Config::mOrder

SequenceIndex mOrder

The sequence in which the configuration was created.

Definition: Config.hpp:61

Here is the caller graph for this function:

const string& torc::physical::Routethrough::getSetting ( void ) const

inline

Returns the _ROUTETHROUGH setting.

Definition at line 62 of file Routethrough.hpp.

62 { return mSetting; }

torc::physical::Routethrough::mSetting

string mSetting

The _ROUTETHROUGH setting in the associated instance.

Definition: Routethrough.hpp:39

Here is the caller graph for this function:

const WireName& torc::physical::Routethrough::getSinkWireName ( void ) const

inline

Returns the instance sink wire name.

Definition at line 68 of file Routethrough.hpp.

68 { return mSinkWireName; }

torc::physical::Routethrough::mSinkWireName

WireName mSinkWireName

The routethrough instance sink wire.

Definition: Routethrough.hpp:45

Here is the caller graph for this function:

const WireName& torc::physical::Routethrough::getSourceWireName ( void ) const

inline

Returns the instance source wire name.

Definition at line 66 of file Routethrough.hpp.

66 { return mSourceWireName; }

torc::physical::Routethrough::mSourceWireName

WireName mSourceWireName

The routethrough instance source wire.

Definition: Routethrough.hpp:43

Here is the caller graph for this function:

const string& torc::physical::Config::getValue ( void ) const

inlineinherited

Return the configuration value.

Definition at line 86 of file Config.hpp.

86 { return mValue; }

torc::physical::Config::mValue

string mValue

The configuration setting value.

Definition: Config.hpp:57

Here is the caller graph for this function:

bool torc::physical::Named::operator== ( const Named & rhs ) const

inlineinherited

Equality operator.

Definition at line 54 of file Named.hpp.

54 { return mName == rhs.mName; }

torc::physical::Named::mName

string mName

The name of the object.

Definition: Named.hpp:43

bool torc::physical::Config::operator== ( const Config & rhs ) const

inlineinherited

Comparison operator.

Returns: true if specified configuration matches this one in both name and value, or false otherwise.

Definition at line 99 of file Config.hpp.

100 { return mName == rhs.mName && mValue == rhs.mValue; }

torc::physical::Named::mName

string mName

The name of the object.

Definition: Named.hpp:43

torc::physical::Config::mValue

string mValue

The configuration setting value.

Definition: Config.hpp:57

void torc::physical::Config::setName ( const string & inName )

inlineinherited

Sets the object name.

Config names can be changed arbitrarily, but other Named subclasses require more complex semantics to prevent name collisions.

Definition at line 94 of file Config.hpp.

94 { mName = inName; }

torc::physical::Named::mName

string mName

The name of the object.

Definition: Named.hpp:43

Here is the caller graph for this function:

void torc::physical::Config::setOrder ( SequenceIndex inOrder )

inlineprotectedinherited

Set the sequence index for this configuration.

Parameters

inOrder The new sequence index.

Definition at line 65 of file Config.hpp.

65 { mOrder = inOrder; }

torc::physical::Config::mOrder

SequenceIndex mOrder

The sequence in which the configuration was created.

Definition: Config.hpp:61

Here is the caller graph for this function:

void torc::physical::Config::setValue ( const string & inValue )

inlineinherited

Set the configuration value.

Definition at line 90 of file Config.hpp.

90 { mValue = inValue; }

torc::physical::Config::mValue

string mValue

The configuration setting value.

Definition: Config.hpp:57

Here is the caller graph for this function:

Field Documentation

InstanceWeakPtr torc::physical::Routethrough::mInstancePtr

protected

The instance in which the routethrough is implemented.

Definition at line 41 of file Routethrough.hpp.

string torc::physical::Named::mName

protectedinherited

The name of the object.

Definition at line 43 of file Named.hpp.

SequenceIndex torc::physical::Config::mOrder

protectedinherited

The sequence in which the configuration was created.

This is used by the XDL exporter to preserve the original order in cases where multiple configurations exist for the same setting name.

Definition at line 61 of file Config.hpp.

string torc::physical::Routethrough::mSetting

protected

The _ROUTETHROUGH setting in the associated instance.

Definition at line 39 of file Routethrough.hpp.

WireName torc::physical::Routethrough::mSinkWireName

protected

The routethrough instance sink wire.

Definition at line 45 of file Routethrough.hpp.

WireName torc::physical::Routethrough::mSourceWireName

protected

The routethrough instance source wire.

Definition at line 43 of file Routethrough.hpp.

string torc::physical::Config::mValue

protectedinherited

The configuration setting value.

Todo:: Consider typing mValue to something like SettingValueString.

Definition at line 57 of file Config.hpp.

const char * torc::physical::Config::sConfigDefaultName = ""

staticprotectedinherited

Default configuration name.

Definition at line 51 of file Config.hpp.

const char * torc::physical::Config::sConfigDefaultValue = "#OFF"

staticprotectedinherited

Default configuration value.

Definition at line 53 of file Config.hpp.

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

Routethrough.hpp

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation