C++ Device API Reference Manual
Reference documentation for the Simics C++ Device API.
 
Loading...
Searching...
No Matches
simics::ConnectBase Class Referenceabstract

A base class for Simics C++ interface connect class. More...

#include <connect.h>

Inheritance diagram for simics::ConnectBase:
simics::Connect< FirstIface, RestIfaces... > simics::Connect< FirstIface, RestIfaces > simics::MapTargetConnect simics::ConnectToDescendant< FirstIface, RestIfaces >

Public Member Functions

 ConnectBase ()
 
virtual ~ConnectBase ()=default
 
virtual bool set (const ConfObjectRef &o)=0
 Set the connected configuration object.
 
ConfObjectRef get () const
 Get the connected configuration object.
 
 operator conf_object_t * () const
 Conversion operator to conf_object_t*.
 

Protected Attributes

ConfObjectRef obj_
 

Detailed Description

A base class for Simics C++ interface connect class.

The ConnectBase class provides common functionality for derived classes that need to manage a connection to a Simics configuration object.

Constructor & Destructor Documentation

◆ ConnectBase()

simics::ConnectBase::ConnectBase ( )
inline

◆ ~ConnectBase()

virtual simics::ConnectBase::~ConnectBase ( )
virtualdefault

Member Function Documentation

◆ get()

ConfObjectRef simics::ConnectBase::get ( ) const
inline

Get the connected configuration object.

Returns
The connected configuration object.

◆ operator conf_object_t *()

simics::ConnectBase::operator conf_object_t * ( ) const
inline

Conversion operator to conf_object_t*.

Returns
A pointer to the connected configuration object.

◆ set()

virtual bool simics::ConnectBase::set ( const ConfObjectRef o)
pure virtual

Set the connected configuration object.

Parameters
oThe configuration object to connect.
Returns
True if the connection was successful, false otherwise.

Implemented in simics::MapTargetConnect, simics::Connect< FirstIface, RestIfaces >, and simics::Connect< FirstIface, RestIfaces... >.

Member Data Documentation

◆ obj_

ConfObjectRef simics::ConnectBase::obj_
protected

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