object_base Class Reference

A virtual base class that specifies some requirements for HOOPLE objects. More...

#include <object_base.h>

Inheritance diagram for object_base:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual ~object_base ()
 requires a virtual destructor.
virtual const char * class_name () const=0
 Returns the bare name of this class as a constant character pointer.
virtual istring instance_name () const
 This returns information about this specific instance of the object.
virtual istring text_form () const
 Provides a text view of all the important info owned by this object.

Detailed Description

A virtual base class that specifies some requirements for HOOPLE objects.

This base class is not required in any sense, but it at least provides a primary virtual root (aiding in design of derived polymorphic objects) and guarantees users that a compliant class offers some basic services. It can be used as a virtual base class to support multiple inheritance. The most derived object must always implement the methods itself, even if inherited objects have also provided implementations. Other base classes are provided in this file as well, such as the clonable base class and the synchronizer_base class.

Definition at line 32 of file object_base.h.


Constructor & Destructor Documentation

object_base::~object_base (  )  [virtual]

requires a virtual destructor.

Definition at line 20 of file object_base.cpp.


Member Function Documentation

virtual const char* object_base::class_name (  )  const [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 (see instance_name() if you need to return specific class member info).

Referenced by blowfish_crypto::decrypt(), cromp_client::enable_encryption(), cromp_server::enable_servers(), blowfish_crypto::encrypt(), instance_name(), tiny_shell::OnClose(), octopus::remove_tentacle(), infoton::set_classifier(), and version_checker::text_form().

istring object_base::instance_name (  )  const [virtual]

This returns information about this specific instance of the object.

By default, it just returns the class name. It can be overridden to provide more information about the object. One intentions of this function is to offer a unique name for this object, compared to the generic class_name(). This is not supposed to be so wordy as the text_form() method.

Definition at line 22 of file object_base.cpp.

References class_name().

Referenced by cromp_client::asynch_connect(), static_memory_gremlin::put(), and text_form().

istring object_base::text_form (  )  const [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. The information can be provided in multiple lines if desired (it is good to use log_base::platform_ending() for the line breaks to help to ensure that the text is formatted appropriately). the default is quite lame and should be overridden.

Reimplemented in buffer, buffer_base, linked_buffer, connection, zingable, internet_address, serial_port_address, ipc_address, address_base, machine_uid_array, socket_minder, string_array, version_checker, version, version_record, geometric::point< numeric_type >, attribute_bundle, menu_base, system_values, file_transfer_tentacle, tokenizer, geometric::point< double >, and geometric::point< int >.

Definition at line 24 of file object_base.cpp.

References instance_name().

Referenced by cromp_client::enable_encryption(), octopus::evaluate(), and cromp_client::synchronous_request().


The documentation for this class was generated from the following files:
Generated on Wed Jul 23 04:35:23 2008 for HOOPLE Libraries by  doxygen 1.5.1