torc::generic::Event Class Reference
Event is used to describe an event on a port or a net using logic state transitions. Events can also be described for unordered groups of ports or nets using portGroup or netGroup. An ordered list of ports may also be used using a portList.
More...
#include <Event.hpp>
List of all members.
|
Public Types |
| enum | Type { eTypeEvent = 0,
eTypeOffsetEvent
} |
| typedef VisitorType< Event > | Visitor |
Public Member Functions |
| virtual void | accept (BaseVisitor &inoutVisitor) throw (Error) |
| const Type | getType () const throw () |
| void | setType (const Type &inSource) throw () |
| void | getPortElements (std::list< PortElement > &outPortElements) const throw () |
| void | addPort (const PortSharedPtr &inPort) throw () |
| void | addPortReference (const PortReferenceSharedPtr &inPortRef) throw () |
| const PortListSharedPtr | getPortList () const throw () |
| void | setPortList (const PortListSharedPtr &inPortList) throw () |
| void | getNets (std::list< NetSharedPtr > &outNets) const throw () |
| void | addNet (const NetSharedPtr &inNet) throw () |
| const LogicElementSharedPtr | getTransition () const throw () |
| void | setTransition (const LogicElementSharedPtr &inSource) throw () |
| const Value | getOffsetTime () const throw () |
| void | setOffsetTime (const Value &value) throw () |
Private Member Functions |
|
| Event (const Event &source) throw () |
|
Event & | operator= (const Event &source) throw () |
Private Attributes |
|
Type | mType |
|
std::list< PortElement > | mPortElements |
|
PortListSharedPtr | mPortList |
|
std::list< NetSharedPtr > | mNets |
|
LogicElementSharedPtr | mTransition |
|
Value | mOffsetTime |
Friends |
|
class | FactoryType< Event > |
Classes |
| class | Factory |
Detailed Description
Event is used to describe an event on a port or a net using logic state transitions. Events can also be described for unordered groups of ports or nets using portGroup or netGroup. An ordered list of ports may also be used using a portList.
This class also models edif OffsetEvent construct, which is used to define a time relative to an Event.
Definition at line 46 of file Event.hpp.
Member Typedef Documentation
Member Enumeration Documentation
Member Function Documentation
| void torc::generic::Event::accept |
( |
BaseVisitor & |
inoutVisitor |
) |
throw (Error) [virtual] |
Recive a inoutVisitor to this class. The visit method of the inoutVisitor 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 inoutVisitor specialization. See Visitor documentation for more details.
- Parameters:
-
| [in,out] | inoutVisitor | A reference to the inoutVisitor 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 96 of file Event.cpp.
| const Event::Type torc::generic::Event::getType |
( |
void |
|
) |
const throw () [inline] |
| void torc::generic::Event::setType |
( |
const Type & |
inSource |
) |
throw () |
Set the event type
- Parameters:
-
Definition at line 115 of file Event.cpp.
| void torc::generic::Event::getPortElements |
( |
std::list< PortElement > & |
outPortElements |
) |
const throw () [inline] |
Get the list of port elements of an Event. When port element list size is more than one, it is portGroup.
- Returns:
- outPortElements List of port elements to be appended to
Definition at line 248 of file Event.hpp.
| void torc::generic::Event::addPort |
( |
const PortSharedPtr & |
inPort |
) |
throw () |
Add a port to the port list.
- Parameters:
-
| [in] | inPort | Pointer to port to be added. |
Definition at line 125 of file Event.cpp.
| void torc::generic::Event::addPortReference |
( |
const PortReferenceSharedPtr & |
inPortRef |
) |
throw () |
Add a port reference to the port list.
- Parameters:
-
| [in] | inPortRef | Pointer to port reference to be added. |
Definition at line 135 of file Event.cpp.
| const PortListSharedPtr torc::generic::Event::getPortList |
( |
|
) |
const throw () [inline] |
Get the pointer to portList of an Event.
- Returns:
- Pointer to portList
Definition at line 260 of file Event.hpp.
| void torc::generic::Event::setPortList |
( |
const PortListSharedPtr & |
inPortList |
) |
throw () |
Set the pointer to portList
- Parameters:
-
| [in] | inPortList | Pointer to portList |
Definition at line 147 of file Event.cpp.
| void torc::generic::Event::getNets |
( |
std::list< NetSharedPtr > & |
outNets |
) |
const throw () [inline] |
Get the list of Net of an Event. When Net element list size is more than one, it is NetGroup.
- Returns:
- outNets List of nets to be appended to
Get the list of nets of an
Event. When
Net element list size is more than one, it is NetGroup.
- Returns:
- outNets List of nets to be appended to
Definition at line 271 of file Event.hpp.
| void torc::generic::Event::addNet |
( |
const NetSharedPtr & |
inNet |
) |
throw () |
Add a Net to the Net list.
- Parameters:
-
| [in] | inNet | Pointer to Net to be added. |
Definition at line 157 of file Event.cpp.
| const LogicElementSharedPtr torc::generic::Event::getTransition |
( |
|
) |
const throw () [inline] |
Get the pointer to logic state value( transition/becomes ).
- Returns:
- Pointer to logic state value( transition/becomes ).
Definition at line 283 of file Event.hpp.
| void torc::generic::Event::setTransition |
( |
const LogicElementSharedPtr & |
inSource |
) |
throw () |
Set the pointer to logic state value( transition/becomes ).
- Parameters:
-
| [in] | inSource | Pointer to logic state value( transition/becomes ). |
Definition at line 167 of file Event.cpp.
| const Value torc::generic::Event::getOffsetTime |
( |
|
) |
const throw () [inline] |
Get the offset time retative to an event.
- Returns:
- Value offset time retative to an event.
Definition at line 292 of file Event.hpp.
| void torc::generic::Event::setOffsetTime |
( |
const Value & |
value |
) |
throw () |
Set the offset time retative to an event.
- Parameters:
-
| [in] | value | Offset time retative to an event. |
Definition at line 176 of file Event.cpp.
The documentation for this class was generated from the following files:
