A base class for objects that can provide a synopsis of their current state. More...
#include <contracts.h>
Public Member Functions | |
| virtual const char * | class_name () const =0 |
| Returns the bare name of this class as a constant character pointer. More... | |
| virtual void | text_form (base_string &state_fill) const =0 |
| Provides a text view of all the important info owned by this object. More... | |
Detailed Description
A base class for objects that can provide a synopsis of their current state.
This helps a lot during debugging and possibly even during normal runtime, since it causes the object to divulge its internal state for viewing in hopefully readable text.
Definition at line 141 of file contracts.h.
Member Function Documentation
◆ class_name()
|
pure virtual |
Returns the bare name of this class as a constant character pointer.
The name returned here is supposed to be just a class name and not provide any more information than that. It is especially important not to add any syntactic elements like '::' to the name, since a bare alphanumeric name is expected.
Implements basis::nameable.
Referenced by octopi::infoton::set_classifier(), octopi::encryption_infoton::text_form(), octopi::encryption_wrapper::text_form(), octopi::file_transfer_infoton::text_form(), octopi::security_infoton::text_form(), manifest_chunk::text_form(), and filesystem::file_time::text_form().
◆ text_form()
|
pure virtual |
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.
Implemented in octopi::octopus_entity, filesystem::file_time, octopi::infoton, timely::time_locus, manifest_chunk, processes::letter, octopi::security_infoton, octopi::file_transfer_infoton, octopi::encryption_wrapper, octopi::encryption_infoton, octopi::unhandled_request, octopi::identity_infoton, structures::string_table, processes::process_entry, processes::OS_event, and basis::astring.
The documentation for this class was generated from the following file:
- /opt/feistymeow.org/feisty_meow/nucleus/library/basis/contracts.h
