C++ Device API Reference Manual
Reference documentation for the Simics C++ Device API.
 
Loading...
Searching...
No Matches
simics::Port< TParent > Class Template Reference

Represents a Simics port object base class. More...

#include <port.h>

Inheritance diagram for simics::Port< TParent >:
simics::ConfObject simics::iface::ConfObjectInterface simics::BankPort< TParent >

Public Member Functions

 Port (const ConfObjectRef &obj)
 
virtual ~Port ()=default
 
TParent * parent () const
 Return a pointer to the C++ object associated with the Simics parent object.
 
const std::string & name ()
 Return the port name.
 
int index () const
 Return the index of an array-type object name.
 
- Public Member Functions inherited from simics::ConfObject
 ConfObject (const ConfObjectRef &obj)
 Create a ConfObject from ConfObjectRef.
 
virtual ~ConfObject ()=default
 
void finalize () override
 
void objects_finalized () override
 
ConfObjectRef obj () const
 Return a ConfObjectRef represents this object.
 
virtual bool finalized ()
 Return if the finalize method has been called.
 
- Public Member Functions inherited from simics::iface::ConfObjectInterface
virtual ~ConfObjectInterface ()=default
 
virtual void finalize ()=0
 
virtual void objects_finalized ()=0
 

Detailed Description

template<typename TParent>
class simics::Port< TParent >

Represents a Simics port object base class.

In Simics, a port object is a child object which is created automatically together with its parent object. With this class, a C++ model model can easily expose same interface more than once.

Constructor & Destructor Documentation

◆ Port()

template<typename TParent >
simics::Port< TParent >::Port ( const ConfObjectRef obj)
inlineexplicit

◆ ~Port()

template<typename TParent >
virtual simics::Port< TParent >::~Port ( )
virtualdefault

Member Function Documentation

◆ index()

template<typename TParent >
int simics::Port< TParent >::index ( ) const
inline

Return the index of an array-type object name.

◆ name()

template<typename TParent >
const std::string & simics::Port< TParent >::name ( )
inline

Return the port name.

◆ parent()

template<typename TParent >
TParent * simics::Port< TParent >::parent ( ) const
inline

Return a pointer to the C++ object associated with the Simics parent object.


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