SST  15.1.0
StructuralSimulationToolkit
SST::WatchPoint Class Reference

Class that can attach to Clock and Event Handlers to monitor the state of variables. More...

#include <watchPoint.h>

Inheritance diagram for SST::WatchPoint:
SST::SSTHandlerBase< returnT, argT >::AttachPoint SST::SSTHandlerBase< returnT, argT >::AttachPoint

Data Structures

class  CheckpointWPAction
 
class  InteractiveWPAction
 
class  Logic
 Base class for performing comparisons and logic operations for determining when the WatchPoint triggers. More...
 
class  PrintStatusWPAction
 
class  PrintTraceWPAction
 
class  SetVarWPAction
 
class  ShutdownWPAction
 
class  WPAction
 WatchPoint Action Inner Classes. More...
 

Public Types

enum  HANDLER : unsigned {
  NONE = 0, BEFORE_CLOCK = 1, AFTER_CLOCK = 2, BEFORE_EVENT = 4,
  AFTER_EVENT = 8, ALL = 15
}
 
enum  LogicOp : unsigned { AND = 0, OR = 1, UNDEFINED = 2 }
 

Public Member Functions

 WatchPoint (size_t index, const std::string &name, Core::Serialization::ObjectMapComparison *obj)
 
uintptr_t registerHandler (const AttachPointMetaData &UNUSED(mdata)) override
 
void beforeHandler (uintptr_t UNUSED(key), const Event *UNUSED(ev)) override
 
void afterHandler (uintptr_t UNUSED(key)) override
 
void beforeHandler (uintptr_t UNUSED(key), const Cycle_t &UNUSED(cycle)) override
 
void afterHandler (uintptr_t UNUSED(key), const bool &UNUSED(ret)) override
 
std::string getName ()
 
size_t getBufferSize ()
 
void printTriggerRecord ()
 
void printTrace ()
 
void setVerbosity (uint32_t v)
 
void msg (const std::string &msg)
 
void setHandler (unsigned handlerType)
 
std::string handlerToString (HANDLER h)
 
void printHandler ()
 
void printWatchpoint ()
 
void resetTraceBuffer ()
 
bool checkReset ()
 
void printAction ()
 
void addTraceBuffer (Core::Serialization::TraceBuffer *tb)
 
void addObjectBuffer (Core::Serialization::ObjectBuffer *ob)
 
void addComparison (Core::Serialization::ObjectMapComparison *cmp)
 
void addLogicOp (LogicOp op)
 
void setAction (WPAction *action)
 
- Public Member Functions inherited from SST::SSTHandlerBase< returnT, argT >::AttachPoint
virtual uintptr_t registerHandler (const AttachPointMetaData &mdata)=0
 Function that will be called when a handler is registered with the tool implementing the attach point. More...
 
virtual void beforeHandler (uintptr_t key, std::conditional_t< std::is_pointer_v< argT >, const std::remove_pointer_t< argT > *, const argT &> arg)=0
 Function to be called before the handler is called. More...
 
virtual void afterHandler (uintptr_t key, std::conditional_t< std::is_pointer_v< returnT >, const std::remove_pointer_t< returnT > *, const returnT &> ret_value)=0
 Function to be called after the handler is called. More...
 
virtual void serializeHandlerAttachPointKey (SST::Core::Serialization::serializer &UNUSED(ser), uintptr_t &UNUSED(key))
 Function that will be called to handle the key returned from registerHandler, if the AttachPoint tool is serializable. More...
 

Static Public Attributes

static const uint32_t VMASK = 0x10
 

Protected Member Functions

bool getInteractive ()
 
void setEnterInteractive ()
 
void setInteractiveMsg (const std::string &msg)
 
SimTime_t getCurrentSimCycle ()
 
void setCheckpoint ()
 
void printStatus ()
 
void heartbeat ()
 
void simulationShutdown ()
 

Detailed Description

Class that can attach to Clock and Event Handlers to monitor the state of variables.


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