torc::generic::InterfaceAttributes Class Reference

Represents attributes of a view interface. More...

#include <InterfaceAttributes.hpp>

Inheritance diagram for torc::generic::InterfaceAttributes:

Collaboration diagram for torc::generic::InterfaceAttributes:

Public Member Functions
const std::string	getDesignator () const
void	setDesignator (const std::string &inSource)
const SimulateSharedPtr	getSimulate () const
void	setSimulate (const SimulateSharedPtr &inSource)
const TimingSharedPtr	getTiming () const
void	setTiming (const TimingSharedPtr &inSource)
	InterfaceAttributes ()
	~InterfaceAttributes () throw ()
	InterfaceAttributes (const InterfaceAttributes &source)
InterfaceAttributes &	operator= (const InterfaceAttributes &source)
void	addComment (const std::string &comment)
const std::vector< std::string > &	getComments () const
void	setComments (const std::vector< std::string > &inSource)
void	getUserData (std::list< std::string > &outUserData) const
void	setUserData (const std::list< std::string > &inSource)
void	addUserData (const std::string &inSource)

Private Attributes
std::string	mDesignator
SimulateSharedPtr	mSimulate
TimingSharedPtr	mTiming

Detailed Description

Represents attributes of a view interface.

The InterfaceAttributes class stores some optional attributes of a view interface.

Definition at line 31 of file InterfaceAttributes.hpp.

Constructor & Destructor Documentation

torc::generic::InterfaceAttributes::InterfaceAttributes

(

)

Definition at line 43 of file InterfaceAttributes.cpp.

                                         : Commentable(), UserDataContainer(), mDesignator(),
    mSimulate(), mTiming() {}

torc::generic::InterfaceAttributes::~InterfaceAttributes	(		)
throw	(
	)

Definition at line 46 of file InterfaceAttributes.cpp.

{}

torc::generic::InterfaceAttributes::InterfaceAttributes

(

const InterfaceAttributes &

source

)

Member Function Documentation

void torc::generic::Commentable::addComment ( const std::string &  comment )

inherited

Add a comment to the object

Parameters

[in]

comment

The comment to add to an existing list of comments

Definition at line 36 of file Commentable.cpp.

                                                     {
    mComments.push_back(comment);
}

void torc::generic::UserDataContainer::addUserData ( const std::string &  inSource )

inherited

Add an user data to the list of user data

Parameters

[in]

inSource

An user data as string

Definition at line 34 of file UserDataContainer.cpp.

                                                             {
    mUserData.push_back(inSource);
}

const std::vector< std::string > & torc::generic::Commentable::getComments ( ) const

inlineinherited

Get the list of all comments

Returns

A list of all comments on this object

Definition at line 85 of file Commentable.hpp.

                                                                  {
    return mComments;
}

const std::string torc::generic::InterfaceAttributes::getDesignator ( ) const

inline

Get the designated number.

Returns

std::string Value representing designated number of a view interface.

Definition at line 91 of file InterfaceAttributes.hpp.

                                                                {
    return mDesignator;
}

const SimulateSharedPtr torc::generic::InterfaceAttributes::getSimulate ( ) const

inline

Get the pointer to the simulate.

Returns

Pointer to the simulate

Get the pointer to the simulate.

Returns

Pointer to the simulatie

Definition at line 100 of file InterfaceAttributes.hpp.

                                                                      {
    return mSimulate;
}

const TimingSharedPtr torc::generic::InterfaceAttributes::getTiming ( ) const

inline

Get the pointer to the timing object

Returns

Pointer to the timing object

Definition at line 109 of file InterfaceAttributes.hpp.

                                                                  {
    return mTiming;
}

void torc::generic::UserDataContainer::getUserData ( std::list< std::string > &  outUserData ) const

inlineinherited

Get the list of all userData

Parameters

[out]

outUserData

The list of all userData

Definition at line 78 of file UserDataContainer.hpp.

                                                                                {
    outUserData.insert(outUserData.end(), mUserData.begin(), mUserData.end());
    return;
}

InterfaceAttributes& torc::generic::InterfaceAttributes::operator=

(

const InterfaceAttributes &

source

)

void torc::generic::Commentable::setComments ( const std::vector< std::string > &  inSource )

inherited

Get the list of all comments

Parameters

[in]

inSource

A list of all comments to be set on this object

Definition at line 45 of file Commentable.cpp.

                                                                  {
    mComments.insert(mComments.end(), inSource.begin(), inSource.end());
}

void torc::generic::InterfaceAttributes::setDesignator

(

const std::string &

inSource

)

Set the designated number.

Parameters

[in]

inSource

std::string representing designated number of a view interface.

Definition at line 21 of file InterfaceAttributes.cpp.

                                                                 {
    mDesignator = inSource;
}

void torc::generic::InterfaceAttributes::setSimulate

(

const SimulateSharedPtr &

inSource

)

Set the pointer to the simulate.

Parameters

[in]

inSource

Pointer to the simulate

Definition at line 30 of file InterfaceAttributes.cpp.

                                                                       {
    mSimulate = inSource;
}

void torc::generic::InterfaceAttributes::setTiming

(

const TimingSharedPtr &

inSource

)

Set the pointer to the timing object

Parameters

[in]

inSource

Pointer to the timing object

Definition at line 39 of file InterfaceAttributes.cpp.

                                                                   {
    mTiming = inSource;
}

void torc::generic::UserDataContainer::setUserData ( const std::list< std::string > &  inSource )

inherited

Set the list of userData

Parameters

[in]

inSource

The list of UserData

Definition at line 26 of file UserDataContainer.cpp.

                                                                      {
    mUserData.insert(mUserData.end(), inSource.begin(), inSource.end());
}

Field Documentation

std::string torc::generic::InterfaceAttributes::mDesignator

private

Definition at line 85 of file InterfaceAttributes.hpp.

SimulateSharedPtr torc::generic::InterfaceAttributes::mSimulate

private

Definition at line 86 of file InterfaceAttributes.hpp.

TimingSharedPtr torc::generic::InterfaceAttributes::mTiming

private

Definition at line 87 of file InterfaceAttributes.hpp.

---

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

• InterfaceAttributes.hpp
• InterfaceAttributes.cpp