SST  14.1.0
StructuralSimulationToolkit
Public Member Functions | Data Fields
SST::Interfaces::StandardMem::CustomReq Class Reference
Inheritance diagram for SST::Interfaces::StandardMem::CustomReq:
SST::Interfaces::StandardMem::Request

Public Member Functions

 CustomReq (CustomData *data, flags_t flags=0, Addr iPtr=0, uint32_t tid=0)
 
virtual Request * makeResponse () override
 
virtual bool needsResponse () override
 
SST::Event * convert (RequestConverter *converter) override
 
void handle (RequestHandler *handler) override
 
std::string getString () override
 
CustomData & getData ()
 Get the CustomData object associated with this request. More...
 
const CustomData & getData () const
 Get the CustomData object associated with this request. More...
 
void setData (CustomData *d)
 Set the CustomData object associated with this request to a new value. More...
 
CustomData * resetData (CustomData *d=nullptr)
 Reset the CustomData object associated with this request to a new value. More...
 
CustomData * releaseData ()
 Obtain the CustomData object associated with this request. More...
 
- Public Member Functions inherited from SST::Interfaces::StandardMem::Request
 Request (flags_t fl=0)
 
 Request (id_t rid, flags_t flags=0)
 
id_t getID ()
 
void setNoncacheable ()
 
void unsetNoncacheable ()
 
bool getNoncacheable ()
 
void setSuccess ()
 
void unsetSuccess ()
 
bool getSuccess ()
 
bool getFail ()
 
void setFail ()
 
void unsetFail ()
 
void setTrace ()
 
void unsetTrace ()
 
bool getTrace ()
 
void setFlag (flags_t flag)
 
void setFlag (Flag flag)
 
void unsetFlag (flags_t flag)
 
void unsetFlag (Flag flag)
 
bool getFlag (flags_t flag)
 
bool getFlag (Flag flag)
 
void clearAllFlags ()
 
flags_t getAllFlags ()
 
std::string getFlagString ()
 

Data Fields

CustomData * data
 
Addr iPtr
 
uint32_t tid
 

Additional Inherited Members

- Public Types inherited from SST::Interfaces::StandardMem::Request
enum  Flag { F_NONCACHEABLE = 1 << 1, F_FAIL = 1 << 2, F_TRACE = 1 << 3, F_RESERVED = 1 << 16 }
 Flags that modify requests. More...
 
typedef uint64_t id_t
 
typedef uint32_t flags_t
 
- Protected Attributes inherited from SST::Interfaces::StandardMem::Request
id_t id
 
flags_t flags
 

Member Function Documentation

◆ getData() [1/2]

CustomData& SST::Interfaces::StandardMem::CustomReq::getData ( )
inline

Get the CustomData object associated with this request.

Ownership of the CustomData object is retained by this request.

◆ getData() [2/2]

const CustomData& SST::Interfaces::StandardMem::CustomReq::getData ( ) const
inline

Get the CustomData object associated with this request.

Ownership of the CustomData object is retained by this request. The returned data cannot be modified.

◆ releaseData()

CustomData* SST::Interfaces::StandardMem::CustomReq::releaseData ( )
inline

Obtain the CustomData object associated with this request.

Ownership of the CustomData object is transferred to the caller. The data member of this request is set to nullptr.

References resetData().

◆ resetData()

CustomData* SST::Interfaces::StandardMem::CustomReq::resetData ( CustomData *  d = nullptr)
inline

Reset the CustomData object associated with this request to a new value.

The previous CustomData object is returned and ownership is transferred to the caller. This request assumes ownership of the passed in CustomData object. If no CustomData object is passed in, the data member is set to nullptr.

Referenced by releaseData().

◆ setData()

void SST::Interfaces::StandardMem::CustomReq::setData ( CustomData *  d)
inline

Set the CustomData object associated with this request to a new value.

This request takes ownership of the CustomData object. The previous CustomData object is deleted.

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