SST 15.0
Structural Simulation Toolkit
Public Member Functions | Data Fields
SST::Interfaces::StandardMem::CustomResp Class Reference
Inheritance diagram for SST::Interfaces::StandardMem::CustomResp:
SST::Interfaces::StandardMem::Request SST::Core::Serialization::serializable SST::Core::Serialization::serializable_base

Public Member Functions

 CustomResp (id_t id, CustomData *data, flags_t flags=0, Addr iPtr=0, uint32_t tid=0)
 
 CustomResp (CustomReq *req)
 
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 response.
 
const CustomData & getData () const
 Get the CustomData object associated with this response.
 
void setData (CustomData *d)
 Set the CustomData object associated with this response to a new value.
 
CustomData * resetData (CustomData *d=nullptr)
 Reset the CustomData object associated with this response to a new value.
 
CustomData * releaseData ()
 Obtain the CustomData object associated with this response.
 
virtual void serialize_order (SST::Core::Serialization::serializer &ser) override
 
 ImplementSerializable (SST::Interfaces::StandardMem::CustomResp)
 
- 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 ()
 
 ImplementVirtualSerializable (SST::Interfaces::StandardMem::Request)
 
- Public Member Functions inherited from SST::Core::Serialization::serializable_base
virtual const char * cls_name () const =0
 
virtual uint32_t cls_id () const =0
 
virtual std::string serialization_name () const =0
 

Data Fields

CustomData * data
 
Addr iPtr
 
uint32_t tid
 

Additional Inherited Members

- Public Types inherited from SST::Interfaces::StandardMem::Request
enum class  Flag { F_NONCACHEABLE = 1 << 1 , F_FAIL = 1 << 2 , F_TRACE = 1 << 3 , F_RESERVED = 1 << 16 }
 Flags that modify requests. More...
 
using id_t = uint64_t
 
using flags_t = uint32_t
 
- Static Public Attributes inherited from SST::Core::Serialization::serializable
static constexpr uint32_t NullClsId = std::numeric_limits<uint32_t>::max()
 
- Static Public Attributes inherited from SST::Core::Serialization::serializable_base
static constexpr uint32_t NullClsId = std::numeric_limits<uint32_t>::max()
 
- Protected Types inherited from SST::Core::Serialization::serializable_base
enum  cxn_flag_t { ConstructorFlag }
 
- Static Protected Member Functions inherited from SST::Core::Serialization::serializable_base
static void serializable_abort (uint32_t line, const char *file, const char *func, const char *obj)
 
- Protected Attributes inherited from SST::Interfaces::StandardMem::Request
id_t id
 
flags_t flags
 

Member Function Documentation

◆ convert()

SST::Event * SST::Interfaces::StandardMem::CustomResp::convert ( RequestConverter * converter)
inlineoverridevirtual

Implements SST::Interfaces::StandardMem::Request.

◆ getData() [1/2]

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

Get the CustomData object associated with this response.

Ownership of the CustomData object is retained by this response.

◆ getData() [2/2]

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

Get the CustomData object associated with this response.

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

◆ getString()

std::string SST::Interfaces::StandardMem::CustomResp::getString ( )
inlineoverridevirtual

Implements SST::Interfaces::StandardMem::Request.

◆ handle()

void SST::Interfaces::StandardMem::CustomResp::handle ( RequestHandler * handler)
inlineoverridevirtual

Implements SST::Interfaces::StandardMem::Request.

◆ makeResponse()

virtual Request * SST::Interfaces::StandardMem::CustomResp::makeResponse ( )
inlineoverridevirtual

Implements SST::Interfaces::StandardMem::Request.

◆ needsResponse()

virtual bool SST::Interfaces::StandardMem::CustomResp::needsResponse ( )
inlineoverridevirtual

Implements SST::Interfaces::StandardMem::Request.

◆ releaseData()

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

Obtain the CustomData object associated with this response.

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

References resetData().

◆ resetData()

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

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

The previous CustomData object is returned and ownership is transferred to the caller. This response 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().

◆ serialize_order()

virtual void SST::Interfaces::StandardMem::CustomResp::serialize_order ( SST::Core::Serialization::serializer & ser)
inlineoverridevirtual

Reimplemented from SST::Interfaces::StandardMem::Request.

◆ setData()

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

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

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

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