feisty meow concerns codebase  2.140
processes::OS_event Class Reference

Models an OS-level event so we can represent activities occurring there. More...

#include <os_event.h>

Inheritance diagram for processes::OS_event:
Collaboration diagram for processes::OS_event:

Public Member Functions

 DEFINE_CLASS_NAME ("OS_event")
 
 OS_event (int event_type, basis::un_int message, basis::un_int parm1, basis::un_int parm2)
 
virtual void text_form (basis::base_string &fill) const
 Provides a text view of all the important info owned by this object. More...
 
basis::astring text_form () const
 
- Public Member Functions inherited from processes::letter
 letter (int type=0, int start_after=0)
 constructs a letter with the "type" and initial pause of "start_after". More...
 
 letter (const letter &to_copy)
 copy constructor for base parts. More...
 
virtual ~letter ()
 derived classes should also implement this. More...
 
letteroperator= (const letter &to_copy)
 assignment operator for base object. More...
 
int type () const
 returns the type of letter held here. More...
 
bool ready_to_send ()
 returns true if this letter is ready to More...
 
void set_ready_time (int start_after)
 resets the time when this letter is ready to be sent. More...
 
- Public Member Functions inherited from basis::text_formable
virtual const char * class_name () const =0
 Returns the bare name of this class as a constant character pointer. More...
 

Public Attributes

basis::un_int _message
 
basis::un_int _parm1
 
basis::un_int _parm2
 

Detailed Description

Models an OS-level event so we can represent activities occurring there.

Definition at line 30 of file os_event.h.

Constructor & Destructor Documentation

◆ OS_event()

processes::OS_event::OS_event ( int  event_type,
basis::un_int  message,
basis::un_int  parm1,
basis::un_int  parm2 
)
inline

Definition at line 39 of file os_event.h.

Member Function Documentation

◆ DEFINE_CLASS_NAME()

processes::OS_event::DEFINE_CLASS_NAME ( "OS_event"  )

◆ text_form() [1/2]

basis::astring processes::OS_event::text_form ( ) const
inline

Definition at line 45 of file os_event.h.

References _message, _parm1, and _parm2.

Referenced by text_form().

◆ text_form() [2/2]

virtual void processes::OS_event::text_form ( basis::base_string state_fill) const
inlinevirtual

Provides a text view of all the important info owned by this object.

It is understood that there could be a large amount of information and that this function might take a relatively long time to complete.

Implements basis::text_formable.

Definition at line 42 of file os_event.h.

References basis::base_string::assign(), and text_form().

Member Data Documentation

◆ _message

basis::un_int processes::OS_event::_message

Definition at line 33 of file os_event.h.

Referenced by text_form().

◆ _parm1

basis::un_int processes::OS_event::_parm1

Definition at line 34 of file os_event.h.

Referenced by text_form().

◆ _parm2

basis::un_int processes::OS_event::_parm2

Definition at line 35 of file os_event.h.

Referenced by text_form().


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