This class is used to model logicInput/logicOutput construct. This class holds information of logical response to be expected from a ports during simulation. More...

#include <LogicalResponse.hpp>

Inheritance diagram for torc::generic::LogicalResponse:

Collaboration diagram for torc::generic::LogicalResponse:

Data Structures
class	Factory

Public Types
enum	ResponseType { eResponseTypeInput = 0, eResponseTypeOutput }

typedef VisitorType < LogicalResponse >	Visitor

typedef LogicalResponse	Type

typedef boost::shared_ptr< Type >	Pointer

typedef boost::weak_ptr< Type >	WeakPointer

Public Member Functions
const ResponseType	getResponseType () const

void	setResponseType (const ResponseType &inSource)

virtual void	accept (BaseVisitor &inoutVisitor) throw (Error)

const PortSharedPtr	getConnectedPort () const

void	setConnectedPort (const PortSharedPtr &inPort)

const PortListSharedPtr	getConnectedPortList () const

void	setConnectedPortList (const PortListSharedPtr &inPortList)

const PortListAliasSharedPtr	getConnectedPortListAlias () const

void	setConnectedPortListAlias (const PortListAliasSharedPtr &inPortListAlias)

const LogicElementSharedPtr	getLogicWaveForm () const

void	setLogicWaveForm (const LogicElementSharedPtr &inSource)

	~LogicalResponse () throw ()

void	setWeakThis (const WeakPointer &inWeakThis)

Pointer	getSharedThis () const

Protected Member Functions
	LogicalResponse ()

Private Member Functions
	LogicalResponse (const LogicalResponse &source)

LogicalResponse &	operator= (const LogicalResponse &source)

Private Attributes
ResponseType	mResponseType

PortSharedPtr	mConnectedPort

PortListSharedPtr	mConnectedPortList

PortListAliasSharedPtr	mConnectedPortListAlias

LogicElementSharedPtr	mLogicWaveForm

Friends
class	FactoryType< LogicalResponse >

Detailed Description

This class is used to model logicInput/logicOutput construct. This class holds information of logical response to be expected from a ports during simulation.

Definition at line 38 of file LogicalResponse.hpp.

Member Typedef Documentation

typedef boost::shared_ptr<Type> torc::generic::SelfReferencing< LogicalResponse >::Pointer

inherited

Definition at line 36 of file SelfReferencing.hpp.

typedef LogicalResponse torc::generic::SelfReferencing< LogicalResponse >::Type

inherited

Definition at line 35 of file SelfReferencing.hpp.

typedef VisitorType<LogicalResponse> torc::generic::LogicalResponse::Visitor

Convenience class to visit LogicalResponse.

Definition at line 67 of file LogicalResponse.hpp.

typedef boost::weak_ptr<Type> torc::generic::SelfReferencing< LogicalResponse >::WeakPointer

inherited

Definition at line 37 of file SelfReferencing.hpp.

Member Enumeration Documentation

enum torc::generic::LogicalResponse::ResponseType

Logical response types (logicInput/logicOutput)

Enumerator
eResponseTypeInput
eResponseTypeOutput

Definition at line 46 of file LogicalResponse.hpp.

                       {
         eResponseTypeInput = 0, eResponseTypeOutput
     };

Constructor & Destructor Documentation

torc::generic::LogicalResponse::~LogicalResponse	(	)
throw	(
	)

Definition at line 110 of file LogicalResponse.cpp.

110 {}

torc::generic::LogicalResponse::LogicalResponse ( )

protected

Definition at line 106 of file LogicalResponse.cpp.

                                  : Visitable(), SelfReferencing<LogicalResponse>(),
     mResponseType(), mConnectedPort(), mConnectedPortList(), mConnectedPortListAlias(),
     mLogicWaveForm() {}

torc::generic::LogicalResponse::LogicalResponse ( const LogicalResponse & source )

private

Member Function Documentation

void torc::generic::LogicalResponse::accept	(	BaseVisitor &	inoutVisitor	)
throw	(	Error
	)

virtual

Implements torc::generic::Visitable.

Definition at line 52 of file LogicalResponse.cpp.

                                                                     {
     try {
         runVisitor(*this, inoutVisitor);
     } catch(Error& e) {
         e.setCurrentLocation(__FUNCTION__, __FILE__, __LINE__);
         throw;
     }
 }

Here is the call graph for this function:

const PortSharedPtr torc::generic::LogicalResponse::getConnectedPort ( ) const

inline

Get the connected port shared pointer.

Returns: Connected port shared pointer.

Definition at line 180 of file LogicalResponse.hpp.

                                                                    {
     return mConnectedPort;
 }

const PortListSharedPtr torc::generic::LogicalResponse::getConnectedPortList ( ) const

inline

Get the connected port list shared pointer.

Returns: Connected port list shared pointer.

Definition at line 189 of file LogicalResponse.hpp.

                                                                            {
     return mConnectedPortList;
 }

const PortListAliasSharedPtr torc::generic::LogicalResponse::getConnectedPortListAlias ( ) const

inline

Get the connected port list alias shared pointer.

Returns: Connected port list alias shared pointer.

Definition at line 198 of file LogicalResponse.hpp.

                                                                                      {
     return mConnectedPortListAlias;
 }

const LogicElementSharedPtr torc::generic::LogicalResponse::getLogicWaveForm ( ) const

inline

Get the logic wave form for this response.

Returns: LogicElementSharedPtr Pointer to logic element object.

Definition at line 207 of file LogicalResponse.hpp.

                                                                            {
     return mLogicWaveForm;
 }

const LogicalResponse::ResponseType torc::generic::LogicalResponse::getResponseType ( ) const

inline

Get the Logical response type

Returns: Logical response type

Definition at line 171 of file LogicalResponse.hpp.

                                                                                 {
     return mResponseType;
 }

Pointer torc::generic::SelfReferencing< LogicalResponse >::getSharedThis ( ) const

inlineinherited

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Returns: A shared pointer to this object

Get a shared pointer to this object. A valid pointer is returned if weakThis was set. Otherwise this returns a NULL pointer. For Vector types, the second scenario is an exception condition and should be treated as such.

Parameters

[out] ptr Set to a shared pointer to this object

LogicalResponse& torc::generic::LogicalResponse::operator= ( const LogicalResponse & source )

private

void torc::generic::LogicalResponse::setConnectedPort ( const PortSharedPtr & inPort )

Set the connected port shared pointer.

Parameters

[in] inPort Connected port shared pointer.

Definition at line 75 of file LogicalResponse.cpp.

                                                                   {
     mConnectedPort = inPort;
 }

void torc::generic::LogicalResponse::setConnectedPortList ( const PortListSharedPtr & inPortList )

Set the connected port list shared pointer.

Parameters

[in] inPortList Connected port list shared pointer.

Definition at line 84 of file LogicalResponse.cpp.

                                                                               {
     mConnectedPortList = inPortList;
 }

void torc::generic::LogicalResponse::setConnectedPortListAlias ( const PortListAliasSharedPtr & inPortListAlias )

Set the connected port list alias shared pointer.

Parameters

[in] inPortListAlias Connected port list alias shared pointer.

Definition at line 93 of file LogicalResponse.cpp.

                                                                                              {
     mConnectedPortListAlias = inPortListAlias;
 }

void torc::generic::LogicalResponse::setLogicWaveForm ( const LogicElementSharedPtr & inSource )

Set the logic wave form for this response.

Parameters

[in] inSource Pointer to logic element object.

Definition at line 102 of file LogicalResponse.cpp.

                                                                             {
     mLogicWaveForm = inSource;
 }

void torc::generic::LogicalResponse::setResponseType ( const ResponseType & inSource )

Set the Logical response type

Parameters

[in] inSource Logical response type

Definition at line 66 of file LogicalResponse.cpp.

                                                                   {
     mResponseType = inSource;
 }

void torc::generic::SelfReferencing< LogicalResponse >::setWeakThis ( const WeakPointer & inWeakThis )

inlineinherited

Set a weak pointer to this object. This will be used later to get a shared pointer to this object from within other member methods if required. This should be called by the Factory creating the object.

Parameters

[in] weakThis A weak pointer to this object

Friends And Related Function Documentation

friend class FactoryType< LogicalResponse >

friend

Definition at line 39 of file LogicalResponse.hpp.

Field Documentation

PortSharedPtr torc::generic::LogicalResponse::mConnectedPort

private

Definition at line 159 of file LogicalResponse.hpp.

PortListSharedPtr torc::generic::LogicalResponse::mConnectedPortList

private

Definition at line 160 of file LogicalResponse.hpp.

PortListAliasSharedPtr torc::generic::LogicalResponse::mConnectedPortListAlias

private

Definition at line 161 of file LogicalResponse.hpp.

LogicElementSharedPtr torc::generic::LogicalResponse::mLogicWaveForm

private

Definition at line 162 of file LogicalResponse.hpp.

ResponseType torc::generic::LogicalResponse::mResponseType

private

Definition at line 158 of file LogicalResponse.hpp.

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

Data Structures

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation