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

Base class for all Simics configuration objects. More...

#include <conf-object.h>

Inheritance diagram for simics::ConfObject:
simics::ConfObjectInterface simics::Port< GeneratedRegisterDevice > simics::Port< SampleDevice > simics::Port< MappableConfObject > simics::MappableConfObject simics::Port< TParent > GeneratedRegisterDevice SampleDevice simics::BankPort< GeneratedRegisterDevice > simics::BankPort< SampleDevice > simics::BankPort< MappableConfObject > simics::BankPort< TParent > SampleBankPort SampleBankPortManual simics::SimpleBankPort< TPortBank, Args >

Public Member Functions

 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::ConfObjectInterface
virtual ~ConfObjectInterface ()=default
 
virtual void finalize ()=0
 
virtual void objects_finalized ()=0
 

Detailed Description

Base class for all Simics configuration objects.

Every device class that inherits from the ConfObject class, whether directly or indirectly, can be registered as a Simics class. However, registration is not automatic; it requires either the use of the RegisterWithSimics template class or the invocation of the make_class template function.

Additionally, custom behavior that occurs after this object or all objects are finalized can be implemented by overriding methods in the ConfObjectInterface.

Constructor & Destructor Documentation

◆ ConfObject()

simics::ConfObject::ConfObject ( const ConfObjectRef obj)
inlineexplicit

Create a ConfObject from ConfObjectRef.

◆ ~ConfObject()

virtual simics::ConfObject::~ConfObject ( )
virtualdefault

Member Function Documentation

◆ finalize()

void simics::ConfObject::finalize ( )
inlineoverridevirtual

◆ finalized()

virtual bool simics::ConfObject::finalized ( )
inlinevirtual

Return if the finalize method has been called.

◆ obj()

ConfObjectRef simics::ConfObject::obj ( ) const
inline

Return a ConfObjectRef represents this object.

◆ objects_finalized()

void simics::ConfObject::objects_finalized ( )
inlineoverridevirtual

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