torc::generic::InterfaceJoinedInfo Class Reference

Represents the Interface joining information. More...

#include <InterfaceJoinedInfo.hpp>

Inheritance diagram for torc::generic::InterfaceJoinedInfo:

Collaboration diagram for torc::generic::InterfaceJoinedInfo:

List of all members.

Public Types

enum JoinedType { eJoinedTypeJoin = 0, eJoinedTypeWeak, eJoinedTypeMust }

enum RelationType { eRelationTypeParent = 0, eRelationTypeChild }

typedef VisitorType
< InterfaceJoinedInfo > Visitor

Public Member Functions

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

Recive a visitor to this class. The visit method of the visitor is called and a reference to this object is passed as a parameter. It has to be noted however, that a dynamic_cast is performed inside this method. If the cast fails, an appropriate exception is thrown by this method. This sitation can arise when the passed Visitor object does not inherit from the appropriate visitor specialization. See Visitor documentation for more details.

const JoinedType getJoinedType () const throw ()

void setJoinedType (const JoinedType &inSource) throw ()

void addPort (const PortSharedPtr &inPort) throw (Error)

void getPorts (std::list< PortSharedPtr > &outPorts) const throw ()

void setPorts (const std::list< PortSharedPtr > &inSource) throw ()

void addPortList (const PortListSharedPtr &inPortList) throw ()

void getPortLists (std::list< PortListSharedPtr > &outPortLists) const throw ()

void setPortLists (const std::list< PortListSharedPtr > &inSource) throw ()

void getChildren (std::vector< InterfaceJoinedInfoSharedPtr > &outJoinedInfos) const throw ()

void setChildren (const std::vector< InterfaceJoinedInfoSharedPtr > &inSource) throw ()

bool addChildJoinedInfo (const InterfaceJoinedInfoSharedPtr &inChildJoinInfo) throw ()

template<typename _Action>

void applyOnAllChildren (const _Action &action) throw (Error)

const RelationType getRelationType () const throw ()

void setRelationType (const RelationType &inSource) throw ()

size_t getSize () const throw ()

Private Attributes

JoinedType mJoinedType

RelationType mRelationType

std::list< PortSharedPtr > mJoinedPorts

std::list< PortListSharedPtr > mJoinedPortLists

std::vector
< InterfaceJoinedInfoSharedPtr > mChildren

Friends

class FactoryType< InterfaceJoinedInfo >

Classes

class Factory

Detailed Description

Represents the Interface joining information.

The InterfaceJoinedInfo class is used to hold interface joining information. Joining information specify which ports (scalar port, array of ports, bundle of ports) or port lists are shorted together.

Definition at line 44 of file InterfaceJoinedInfo.hpp.

Member Typedef Documentation

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

Convenience class to visit an interface joining information.

Definition at line 77 of file InterfaceJoinedInfo.hpp.

Member Enumeration Documentation

enum torc::generic::InterfaceJoinedInfo::JoinedType

Interface joining type

Definition at line 55 of file InterfaceJoinedInfo.hpp.

enum torc::generic::InterfaceJoinedInfo::RelationType

Type of the InterfaceJoinedInfo, Is it parent or child.

Definition at line 67 of file InterfaceJoinedInfo.hpp.

Member Function Documentation

void torc::generic::InterfaceJoinedInfo::accept ( BaseVisitor & visitor ) throw (Error) [virtual]

Recive a visitor to this class. The visit method of the visitor is called and a reference to this object is passed as a parameter. It has to be noted however, that a dynamic_cast is performed inside this method. If the cast fails, an appropriate exception is thrown by this method. This sitation can arise when the passed Visitor object does not inherit from the appropriate visitor specialization. See Visitor documentation for more details.

Parameters:

[in,out] visitor A reference to the visitor object

Exceptions:

Error

Visitor type inappropriate for visiting this object or any other error thrown by the Visitor::throw() method.

Implements torc::generic::Visitable.

Definition at line 211 of file InterfaceJoinedInfo.cpp.

const InterfaceJoinedInfo::JoinedType torc::generic::InterfaceJoinedInfo::getJoinedType ( ) const throw () [inline]

Get the interface joining type

Returns:: Interface joining type

Definition at line 264 of file InterfaceJoinedInfo.hpp.

void torc::generic::InterfaceJoinedInfo::setJoinedType ( const JoinedType & value ) throw ()

Set the interface joining type

Parameters:

[in] inSource Interface joining type

Set the interface joining type

Parameters:

[in] inSource Interface joining type

Definition at line 68 of file InterfaceJoinedInfo.cpp.

void torc::generic::InterfaceJoinedInfo::addPort ( const PortSharedPtr & inPort ) throw (Error)

Add a port to the list of ports. Empty pointer is ignored.

Parameters:

[in] inPort Pointer to port to be added.

Exceptions:

Error

Could not add port, because Port name is empty

Add a port to the list of ports. Empty pointer is ignored.

Parameters:

[in] inPort Pointer to port to be added.

Exceptions:

Error

Could not add port, because Port name is empty

Definition at line 79 of file InterfaceJoinedInfo.cpp.

void torc::generic::InterfaceJoinedInfo::getPorts ( std::list< PortSharedPtr > & outPorts ) const throw () [inline]

Get the list of pointers to the joined ports of an interface

Returns:: outPorts List of ports to be appended to

Definition at line 274 of file InterfaceJoinedInfo.hpp.

void torc::generic::InterfaceJoinedInfo::setPorts ( const std::list< PortSharedPtr > & inSource ) throw ()

Set the list of joined ports of an interface

Parameters:

[in] inSource List of ports to be joined to an interface

Definition at line 115 of file InterfaceJoinedInfo.cpp.

void torc::generic::InterfaceJoinedInfo::addPortList ( const PortListSharedPtr & inPortList ) throw ()

Add a portList to the list of portLists. Empty pointer is ignored.

Parameters:

[in] inPortList Pointer to portList to be added.

Definition at line 101 of file InterfaceJoinedInfo.cpp.

void torc::generic::InterfaceJoinedInfo::getPortLists ( std::list< PortListSharedPtr > & outPortLists ) const throw () [inline]

Get the list of joined portLists of an interface

Returns:: outPortLists List of joined portLists to be appended to

Get the list of joined portLists of an interface

Returns:: outPorts List of joined portLists to be appended to

Definition at line 286 of file InterfaceJoinedInfo.hpp.

void torc::generic::InterfaceJoinedInfo::setPortLists ( const std::list< PortListSharedPtr > & inSource ) throw ()

Set the list of joined portLists of an interface

Parameters:

[in] inSource List of portLists to be joined to an interface

Definition at line 140 of file InterfaceJoinedInfo.cpp.

void torc::generic::InterfaceJoinedInfo::getChildren ( std::vector< InterfaceJoinedInfoSharedPtr > & outJoinedInfos ) const throw () [inline]

Get the nested interface joined info.

Parameters:

[out] outJoinedInfos Vector of interface joined info to be appended to

Definition at line 298 of file InterfaceJoinedInfo.hpp.

void torc::generic::InterfaceJoinedInfo::setChildren ( const std::vector< InterfaceJoinedInfoSharedPtr > & inSource ) throw ()

Set the nested joining information

Parameters:

[in] inSource Vector containing joining informations

Exceptions:

Error

Could not add child joined info because pointer to the joined info does not exist

Set the nested joining information

Parameters:

[in] inSource Vector containing joining informations

Exceptions:

Error

Could not add child joined info because pointer to the joined info does not exist

Definition at line 167 of file InterfaceJoinedInfo.cpp.

bool torc::generic::InterfaceJoinedInfo::addChildJoinedInfo ( const InterfaceJoinedInfoSharedPtr & inChildJoinInfo ) throw ()

Add a joined info to parent joined info

Parameters:

[in] inChildJoinInfo Child interface joined info to be added to parent

Definition at line 192 of file InterfaceJoinedInfo.cpp.

template<typename _Action>

void torc::generic::InterfaceJoinedInfo::applyOnAllChildren ( const _Action & action ) throw (Error) [inline]

Apply action on all children

Parameters:

[in] action Action to be applied

Definition at line 310 of file InterfaceJoinedInfo.hpp.

const InterfaceJoinedInfo::RelationType torc::generic::InterfaceJoinedInfo::getRelationType ( ) const throw () [inline]

Get the relation type.

Returns:: RelationType

Definition at line 333 of file InterfaceJoinedInfo.hpp.

void torc::generic::InterfaceJoinedInfo::setRelationType ( const RelationType & inSource ) throw ()

Set the relation type.

Parameters:

[in] inSource RelationType

Definition at line 230 of file InterfaceJoinedInfo.cpp.

size_t torc::generic::InterfaceJoinedInfo::getSize ( void ) const throw ()

Get the total number of bits of the composition

Returns:: Number of bits

Definition at line 239 of file InterfaceJoinedInfo.cpp.

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

torc/generic/om/InterfaceJoinedInfo.hpp
torc/generic/om/InterfaceJoinedInfo.cpp


Public Types
enum	JoinedType { eJoinedTypeJoin = 0, eJoinedTypeWeak, eJoinedTypeMust }
enum	RelationType { eRelationTypeParent = 0, eRelationTypeChild }
typedef VisitorType < InterfaceJoinedInfo >	Visitor
Public Member Functions
virtual void	accept (BaseVisitor &visitor) throw (Error)
	Recive a visitor to this class. The visit method of the visitor is called and a reference to this object is passed as a parameter. It has to be noted however, that a dynamic_cast is performed inside this method. If the cast fails, an appropriate exception is thrown by this method. This sitation can arise when the passed Visitor object does not inherit from the appropriate visitor specialization. See Visitor documentation for more details.
const JoinedType	getJoinedType () const throw ()
void	setJoinedType (const JoinedType &inSource) throw ()
void	addPort (const PortSharedPtr &inPort) throw (Error)
void	getPorts (std::list< PortSharedPtr > &outPorts) const throw ()
void	setPorts (const std::list< PortSharedPtr > &inSource) throw ()
void	addPortList (const PortListSharedPtr &inPortList) throw ()
void	getPortLists (std::list< PortListSharedPtr > &outPortLists) const throw ()
void	setPortLists (const std::list< PortListSharedPtr > &inSource) throw ()
void	getChildren (std::vector< InterfaceJoinedInfoSharedPtr > &outJoinedInfos) const throw ()
void	setChildren (const std::vector< InterfaceJoinedInfoSharedPtr > &inSource) throw ()
bool	addChildJoinedInfo (const InterfaceJoinedInfoSharedPtr &inChildJoinInfo) throw ()
template<typename _Action>
void	applyOnAllChildren (const _Action &action) throw (Error)
const RelationType	getRelationType () const throw ()
void	setRelationType (const RelationType &inSource) throw ()
size_t	getSize () const throw ()
Private Attributes
JoinedType	mJoinedType
RelationType	mRelationType
std::list< PortSharedPtr >	mJoinedPorts
std::list< PortListSharedPtr >	mJoinedPortLists
std::vector < InterfaceJoinedInfoSharedPtr >	mChildren
Friends
class	FactoryType< InterfaceJoinedInfo >
Classes
class	Factory