torc::generic::PortElement Class Reference

Represents port element like port or port reference. More...

#include <PortElement.hpp>

Public Types
enum	ElementType { eElementTypePort, eElementTypePortReference }

Public Member Functions
const ElementType	getType () const
void	setType (const ElementType &inSource)
const PortSharedPtr	getPort () const
const PortReferenceSharedPtr	getPortReference () const
	PortElement ()
	PortElement (const PortSharedPtr &inPort)
	PortElement (const PortReferenceSharedPtr &inPortRef)
	PortElement (const PortElement &inRhs)
PortElement &	operator= (const PortElement &inRhs)
	~PortElement () throw ()

Private Attributes
ElementType	mType
PortSharedPtr	mPort
PortReferenceSharedPtr	mPortReference

Detailed Description

Represents port element like port or port reference.

Definition at line 32 of file PortElement.hpp.

Member Enumeration Documentation

enum torc::generic::PortElement::ElementType

Port element type

Enumerator
eElementTypePort
eElementTypePortReference

Definition at line 38 of file PortElement.hpp.

                     {
        eElementTypePort, eElementTypePortReference
    };

Constructor & Destructor Documentation

torc::generic::PortElement::PortElement

(

)

Definition at line 34 of file PortElement.cpp.

: mType(eElementTypePort), mPort(), mPortReference() {}

torc::generic::PortElement::PortElement

(

const PortSharedPtr &

inPort

)

Definition at line 36 of file PortElement.cpp.

                                                    :
    mType(eElementTypePort), mPort(inPort), mPortReference() {}

torc::generic::PortElement::PortElement

(

const PortReferenceSharedPtr &

inPortRef

)

Definition at line 39 of file PortElement.cpp.

                                                                :
    mType(eElementTypePortReference), mPort(), mPortReference(inPortRef) {}

torc::generic::PortElement::PortElement

(

const PortElement &

inRhs

)

Definition at line 42 of file PortElement.cpp.

                                                 :
    mType(inRhs.mType), mPort(inRhs.mPort), mPortReference(inRhs.mPortReference) {}

torc::generic::PortElement::~PortElement	(		)
throw	(
	)

Definition at line 54 of file PortElement.cpp.

{}

Member Function Documentation

const PortSharedPtr torc::generic::PortElement::getPort ( ) const

inline

Get the port from the composition

Returns

Pointer to port from the composition

Definition at line 90 of file PortElement.hpp.

                                                      {
    return mPort;
}

const PortReferenceSharedPtr torc::generic::PortElement::getPortReference ( ) const

inline

Get the port reference from the composition

Returns

Pointer to port reference from the composition

Definition at line 94 of file PortElement.hpp.

                                                                        {
    return mPortReference;
}

const PortElement::ElementType torc::generic::PortElement::getType ( void  ) const

inline

Get the port element type

Returns

port element type

Definition at line 86 of file PortElement.hpp.

                                                               {
    return mType;
}

PortElement & torc::generic::PortElement::operator=

(

const PortElement &

inRhs

)

Definition at line 45 of file PortElement.cpp.

                                                             {
    if(this == &inRhs) {
        mType = inRhs.mType;
        mPort = inRhs.mPort;
        mPortReference = inRhs.mPortReference;
    }
    return *this;
}

void torc::generic::PortElement::setType

(

const ElementType &

inSource

)

Set the port element type

Parameters

[in]

Pointer

to port element type

Definition at line 30 of file PortElement.cpp.

                                                     {
    mType = inSource;
}

Field Documentation

PortSharedPtr torc::generic::PortElement::mPort

private

Definition at line 82 of file PortElement.hpp.

PortReferenceSharedPtr torc::generic::PortElement::mPortReference

private

Definition at line 83 of file PortElement.hpp.

ElementType torc::generic::PortElement::mType

private

Definition at line 81 of file PortElement.hpp.

---

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

• PortElement.hpp
• PortElement.cpp