torc-master
|
Represents a port array. More...
#include <VectorPort.hpp>
Data Structures | |
class | Factory |
Public Types | |
typedef Vector< Port, VectorPortBit, VectorPortBit::Factory, true > | BaseVectorType |
typedef VisitorType< VectorPort > | Visitor |
typedef std::list < NetSharedPtr >::iterator | Connection |
typedef boost::signals2::signal< void(const NetSharedPtr &)> | Connected |
typedef boost::signals2::signal< void(const NetSharedPtr &)> | Disconnected |
typedef std::string | Name |
typedef Port | Type |
typedef boost::shared_ptr< Type > | Pointer |
typedef boost::weak_ptr< Type > | WeakPointer |
typedef std::vector< Pointer > | List |
typedef size_t | SizeType |
typedef Composite< Port > | BaseType |
typedef BaseType::Type | Type |
typedef BaseType::List | List |
typedef BaseType::Pointer | Pointer |
typedef BaseType::SizeType | SizeType |
typedef VectorPortBit | ChildType |
typedef boost::shared_ptr < ChildType > | ChildPointer |
typedef VectorPortBit::Factory | ChildFactory |
typedef boost::shared_ptr < VectorPortBit::Factory > | ChildFactorySharedPtr |
Public Member Functions | |
virtual void | setParent (const ViewSharedPtr &inParent) |
virtual void | accept (BaseVisitor &inoutVisitor) throw (Error) |
virtual Connectable::Connection | connect (const NetSharedPtr &inNet) throw (Error) |
void | disconnect (const Connectable::Connection &inConnection) throw (Error) |
virtual void | getConnectedNets (std::vector< NetSharedPtr > &outNets, bool inSkipChildConnections=false) const throw (Error) |
virtual | ~VectorPort () throw () |
const EPortDirection | getDirection () const |
void | setDirection (const EPortDirection &inSource) |
const PortAttributesSharedPtr | getAttributes () const |
void | setAttributes (const PortAttributesSharedPtr &inSource) |
void | addComment (const std::string &comment) |
const std::vector< std::string > & | getComments () const |
void | setComments (const std::vector< std::string > &inSource) |
Connected & | signalNetConnected () |
Disconnected & | signalNetDisconnected () |
void | disconnect (const std::string &inName) throw (Error) |
void | disconnect (const NetSharedPtr &net) throw (Error) |
virtual void | disconnect () throw (Error) |
bool | getIsExtern () const |
bool | isExtern () const |
void | setIsExtern (bool inIsExtern) |
virtual const std::string | getName () const |
void | setName (const std::string &inSource) throw (Error) |
PropertySharedPtr | getProperty (const std::string &inName) |
bool | setProperty (const std::string &inName, const PropertySharedPtr &inProperty) |
void | getProperties (std::map< std::string, PropertySharedPtr > &outProperties) const |
void | setProperties (const std::map< std::string, PropertySharedPtr > &inSource) |
template<typename _Action > | |
void | applyOnAllProperties (const _Action &action) throw (Error) |
virtual Name | getOriginalName () const |
virtual void | setOriginalName (const Name &inSource) |
virtual CompositionType | getCompositionType () const =0 |
virtual size_t | getSize () const =0 |
virtual void | getChildren (List &outChildren) const =0 throw (Error) |
virtual const Pointer | get (const std::vector< SizeType > &inIndices) const =0 throw (Error) |
virtual void | setParentCollection (const Pointer &inParentCollection) |
virtual Pointer | getParentCollection () const |
void | setWeakThis (const WeakPointer &inWeakThis) |
Pointer | getSharedThis () const |
const boost::shared_ptr< View > | getParent () const |
virtual void | setParent (const boost::shared_ptr< View > &inSource) |
void | getUserData (std::list< std::string > &outUserData) const |
void | setUserData (const std::list< std::string > &inSource) |
void | addUserData (const std::string &inSource) |
virtual CompositionType | getCompositionType () const |
virtual SizeType | getSize () const |
virtual const Pointer | get (const std::vector< SizeType > &inIndices) const throw (Error) |
virtual void | getChildren (List &outChildren) const throw (Error) |
void | applyOnAllChildren (const _Action &action) throw (Error) |
virtual void | forceAutoBlast (void) throw (Error) |
virtual void | getCreatedChildren (List &outChildren) const throw (Error) |
void | constructChildren (const boost::shared_ptr< ChildFactory > &inFactory, const std::vector< SizeType > &inLimits) throw (Error) |
void | getLimits (std::vector< SizeType > &outLimits) const |
bool | getIsPreserved () const |
Protected Member Functions | |
virtual void | onChildCreate (const boost::shared_ptr< BaseVectorType::ChildType > &inCreatedChild) const throw (Error) |
VectorPort () | |
virtual void | onConnect () throw (Error) |
virtual void | onDisconnect () throw (Error) |
void | setChildren (const List &inSource) throw (Error) |
virtual void | onAutoBlast () const throw (Error) |
virtual void | onChildCreate (const boost::shared_ptr< ChildType > &inCreatedChild) const throw (Error) |
void | setLimits (const std::vector< SizeType > &inSource) |
const boost::shared_ptr < ChildFactory > | getFactory () const |
void | setFactory (const boost::shared_ptr< ChildFactory > &inSource) |
Friends | |
class | FactoryType< VectorPort > |
Represents a port array.
The VectorPort class represents a port array. Such objects in EDIF are declard using the (port (array ...) ) syntax.
Definition at line 45 of file VectorPort.hpp.
|
inherited |
Definition at line 55 of file Vector.hpp.
typedef Vector<Port, VectorPortBit, VectorPortBit::Factory, true> torc::generic::VectorPort::BaseVectorType |
Definition at line 52 of file VectorPort.hpp.
|
inherited |
Definition at line 62 of file Vector.hpp.
|
inherited |
Definition at line 63 of file Vector.hpp.
|
inherited |
Definition at line 61 of file Vector.hpp.
|
inherited |
Definition at line 60 of file Vector.hpp.
|
inherited |
A signal to indicate that a new connection has been made
Definition at line 57 of file Connectable.hpp.
|
inherited |
A connection between a net and this object
Definition at line 52 of file Connectable.hpp.
|
inherited |
A signal to indicate that a connection has been removed
Definition at line 62 of file Connectable.hpp.
|
inherited |
Definition at line 57 of file Vector.hpp.
|
inherited |
List of Shared Pointers to objects of type Type
Definition at line 61 of file Composite.hpp.
|
inherited |
Definition at line 40 of file generic/Renamable.hpp.
|
inherited |
Shared Pointer to object of type Type
Definition at line 55 of file Composite.hpp.
|
inherited |
Definition at line 58 of file Vector.hpp.
|
inherited |
Definition at line 59 of file Vector.hpp.
|
inherited |
Definition at line 62 of file Composite.hpp.
|
inherited |
Definition at line 50 of file Composite.hpp.
|
inherited |
Definition at line 56 of file Vector.hpp.
Definition at line 54 of file VectorPort.hpp.
|
inherited |
Definition at line 56 of file Composite.hpp.
|
virtual |
|
protected |
Definition at line 204 of file VectorPort.cpp.
|
virtual |
Implements torc::generic::Visitable.
Definition at line 104 of file VectorPort.cpp.
|
inherited |
Add a comment to the object
[in] | comment | The comment to add to an existing list of comments |
Definition at line 36 of file Commentable.cpp.
|
inherited |
Add an user data to the list of user data
[in] | inSource | An user data as string |
Definition at line 34 of file UserDataContainer.cpp.
|
inherited |
|
inlineinherited |
Apply action on all properties.
[in] | action | Action to be applied |
Definition at line 113 of file PropertyContainer.hpp.
|
virtual |
Connect a Net to this object.
[in] | net | A pointer to the Net object that eeds to be connected |
Implements torc::generic::Connectable.
Definition at line 131 of file VectorPort.cpp.
|
inlineinherited |
Create list of children using the provided factory and limits
[in] | inFactory | ChildFactory to use for construcing children |
[in] | inLimits | Array dimensions |
Error | Children could not be created |
Create list of children using the provided factory and limits
[in] | inFactory | ChildFactory to use for construcing children |
[in] | inLimits | Array dimensions |
Error | Children could not be created |
|
virtual |
Disconnect a Net from this object.
[in] | connection | A connection as returned by the connect() method |
Error | Provided connection is invalid |
Implements torc::generic::Connectable.
Definition at line 166 of file VectorPort.cpp.
|
inherited |
Disconnect the named Net from this object.
[in] | inName | Name of the net to be Disconnected |
Error | Provided net was not found |
Disconnect the named Net from this object.
[in] | inNname | Name of the net to be Disconnected |
Error | Provided net was not found |
Definition at line 111 of file Connectable.cpp.
|
inherited |
Disconnect the given Net from this object.
[in] | net | Pointer to a net |
Error | Provided net was not found |
Disconnect the given Net from this object.
[in] | inNet | Pointer to a net |
Error | Provided net was not found |
Definition at line 128 of file Connectable.cpp.
|
virtualinherited |
Disconnect all connections to this port.
Reimplemented in torc::generic::Net, torc::generic::VectorNet, and torc::generic::NetBundle.
Definition at line 132 of file Connectable.cpp.
|
virtualinherited |
Force creation of VectorBit children, even if this is a preserved Vector.
|
pure virtualinherited |
Get a specific member of this composition.
[in] | inIndices | A list of indices to be accessed. The number of indices must be equal to the number of dimensions. |
Error | Index dimensions mismatch |
Implemented in torc::generic::Vector< Port, VectorPortBit, VectorPortBit::Factory, true >, torc::generic::Bundle< Port >, torc::generic::VectorBit< Port >, and torc::generic::Scalar< Port >.
|
virtualinherited |
Get a specific member of this composition.
[in] | inIndices | A list of indices to be accessed. The number of indices must be equal to the number of dimensions. |
Error | Index dimensions mismatch
|
Error | Array index out of bounds
|
Error | Empty Array
|
Get a specific member of this composition.
[in] | inIndices | A list of indices to be accessed. The number of indices must be equal to the number of dimensions. |
Error | Index dimensions mismatch |
Implements torc::generic::Composite< Port >.
|
inlineinherited |
Get the attributes of the port. Attributes include dcFaninLoad, dcFanoutLoad_ etc.
Definition at line 123 of file generic/Port.hpp.
|
pure virtualinherited |
Get children of this composition.
[out] | outChildren | A list of all children for this composition |
Implemented in torc::generic::Vector< Port, VectorPortBit, VectorPortBit::Factory, true >, torc::generic::Scalar< Port >, and torc::generic::VectorBit< Port >.
|
virtualinherited |
Get children of this composition.
[out] | outChildren | A list of all children for this composition |
Error | If factory is not set and preserve is true and the vector has not been blasted, an exception is generated. |
Implements torc::generic::Composite< Port >.
|
inlineinherited |
Get the list of all comments
Definition at line 85 of file Commentable.hpp.
|
pure virtualinherited |
Get the type of this composition.
Implemented in torc::generic::Vector< Port, VectorPortBit, VectorPortBit::Factory, true >, torc::generic::Bundle< Port >, torc::generic::VectorBit< Port >, and torc::generic::Scalar< Port >.
|
virtualinherited |
Get composition type for this object
Implements torc::generic::Composite< Port >.
|
virtual |
Reimplemented from torc::generic::Connectable.
Definition at line 183 of file VectorPort.cpp.
|
virtualinherited |
|
inlineinherited |
Get the direction of port
Definition at line 114 of file generic/Port.hpp.
|
inlineprotectedinherited |
Get current factory
Error | Null Child Factory
|
|
inlineinherited |
Get whether the item is an extern(placeholder) or an actual item.
Definition at line 86 of file Extern.hpp.
|
inlineinherited |
|
inlineinherited |
Get dimensions of the array.
[in] | outLimits | Dimensions of the vector |
Get dimensions of the array.
|
inlinevirtualinherited |
Get the object name
Definition at line 89 of file Nameable.hpp.
|
inlinevirtualinherited |
Get the new name provided for the object.
Definition at line 78 of file generic/Renamable.hpp.
|
inlineinherited |
Get a pointer to the parent object
|
inlinevirtualinherited |
Get a pointer to the parent collection
|
inlineinherited |
Get the map of all properties
[out] | outProperties | The map of properties |
Get the map of all properties
Definition at line 107 of file PropertyContainer.hpp.
|
inherited |
Get a property
[in] | inName | Name of the property to be retreived |
Get a property
[in] | name | Name of the property to be retreived |
Definition at line 37 of file PropertyContainer.cpp.
|
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.
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.
[out] | ptr | Set to a shared pointer to this object |
|
pure virtualinherited |
Get the total number of bits of the composition
Implemented in torc::generic::Vector< Port, VectorPortBit, VectorPortBit::Factory, true >, torc::generic::Bundle< Port >, torc::generic::VectorBit< Port >, and torc::generic::Scalar< Port >.
|
virtualinherited |
Get the total number of bits of the composition
Implements torc::generic::Composite< Port >.
|
inlineinherited |
Get the list of all userData
[out] | outUserData | The list of all userData |
Definition at line 78 of file UserDataContainer.hpp.
|
inlineinherited |
Get whether the item is an extern(placeholder) or an actual item.
Definition at line 95 of file Extern.hpp.
|
protectedvirtualinherited |
|
protectedvirtual |
Definition at line 199 of file VectorPort.cpp.
|
protectedvirtualinherited |
|
protectedvirtualinherited |
A polymorphic function that is called after a net is Connected to this object
Definition at line 144 of file Connectable.cpp.
|
protectedvirtualinherited |
A polymorphic function that is called after a net is Disconnected from this object
Definition at line 149 of file Connectable.cpp.
|
inherited |
Set the attributes of the port. Attributes include dcFaninLoad, dcFanoutLoad_ etc.
[in] | inSource | Pointer to PortAttributes object. |
Definition at line 56 of file generic/Port.cpp.
|
protectedinherited |
Set list of children for unpreserved vector.
[in] | inSource | List of children |
|
inherited |
Get the list of all comments
[in] | inSource | A list of all comments to be set on this object |
Definition at line 45 of file Commentable.cpp.
|
inherited |
Set the direction of port
[in] | inSource | Direction of port |
Definition at line 45 of file generic/Port.cpp.
|
protectedinherited |
Set current factory
[in] | inSource | ChildFactory object |
|
inherited |
Set whether an item is extern or not.
[in] | isExtern | True if extern, false otherwise |
Definition at line 35 of file Extern.cpp.
|
protectedinherited |
Set dimensions of the array.
[in] | inSource | Dimensions of the vector |
|
inherited |
Set a name for this object
[in] | inSource | Name of the object |
Error | Could not set name, because name is empty (Will be used by array members)
|
Set a name for this object
[in] | inSource | Name of the object |
Error | Could not set name, because name is empty (Will be used by array members) |
Definition at line 41 of file Nameable.cpp.
|
virtualinherited |
Set the new name provided for the object.
[in] | inSource | Name of the object |
Definition at line 35 of file generic/Renamable.cpp.
|
virtualinherited |
Set a pointer to the parent
[in] | inSource | Set a pointer to the parent |
|
virtual |
Definition at line 113 of file VectorPort.cpp.
|
inlinevirtualinherited |
Set a pointer to a parnt composition.
[in] | inParentCollection | pointer to the parent collection (Vector/Bundle) |
Set a pointer to a parnt composition.
[in] | parentCollection | pointer to the parent collection (Vector/Bundle) |
|
inherited |
Set the map of properties
[in] | inSource | The map of properties |
Definition at line 66 of file PropertyContainer.cpp.
|
inherited |
Save the inSource of a property
[in] | inName | Name of the property to be saved |
[in] | inProperty | Pointer to the property object if present, empty pointer otherwise. |
Save the inSource of a property
[in] | inName | Name of the property to be saved |
[in] | inPoperty | Pointer to the property object if present, empty pointer otherwise. |
Definition at line 53 of file PropertyContainer.cpp.
|
inherited |
Set the list of userData
[in] | inSource | The list of UserData |
Definition at line 26 of file UserDataContainer.cpp.
|
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.
[in] | weakThis | A weak pointer to this object |
|
inlineinherited |
A signal to indicate that a new connection has been made
Definition at line 167 of file Connectable.hpp.
|
inlineinherited |
A signal to indicate that a new connection has been made
Definition at line 174 of file Connectable.hpp.
|
friend |
Definition at line 49 of file VectorPort.hpp.