#include <crompish_pax.h>

Inheritance diagram for bubble:

[legend]

Collaboration diagram for bubble:

[legend]

Public Member Functions
	bubble (int data_segment_size=0, const structures::string_array &boundaries=structures::string_array(), int color=0)

const structures::string_array &	bubble_classing () const

void	reset (int data_segment_size, const structures::string_array &boundaries, int color)

int	data_length () const

virtual clonable *	clone () const
	must be provided to allow creation of a copy of this object. More...

basis::byte_array &	data ()

int	non_data_overhead () const

virtual void	text_form (basis::base_string &to_show) const
	requires derived infotons to be able to show their state as a string. More...

virtual void	pack (basis::byte_array &packed_form) const
	stuffs the data in the infoton into the "packed_form". More...

int	packed_size () const
	reports how large the infoton will be when packed. More...

virtual bool	unpack (basis::byte_array &packed_form)
	restores an infoton from a packed form. More...

Public Member Functions inherited from octopi::infoton
	infoton (const structures::string_array &classifier)
	creates an infoton with the "classifier". More...

	infoton (const basis::astring &class_1)

	infoton (const basis::astring &class_1, const basis::astring &class_2)

	infoton (const basis::astring &class_1, const basis::astring &class_2, const basis::astring &cl_3)

	infoton (const infoton &to_copy)
	copies only the base class portion of the infoton. More...

virtual	~infoton ()

	DEFINE_CLASS_NAME ("infoton")

infoton &	operator= (const infoton &to_copy)
	assigns only the base class portion. More...

const structures::string_array &	classifier () const
	this array of strings is the "name" for this infoton. More...

void	set_classifier (const structures::string_array &new_classifier)
	sets the infoton's classifier to the "new_classifier". More...

void	set_classifier (const basis::astring &class_1)

void	set_classifier (const basis::astring &class_1, const basis::astring &class_2)

void	set_classifier (const basis::astring &class_1, const basis::astring &class_2, const basis::astring &cl_3)

bool	check_classifier (const basis::astring &class_name, const basis::astring &caller)
	checks that the classifier seems valid. More...

virtual basis::astring	text_form () const
	local version just makes text_form() more functional. 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...

Additional Inherited Members
Static Public Member Functions inherited from octopi::infoton
static void	fast_pack (basis::byte_array &packed_form, const infoton &to_pack)
	flattens an infoton "to_pack" into the byte array "packed_form". More...

static bool	fast_unpack (basis::byte_array &packed_form, structures::string_array &classifier, basis::byte_array &info)
	undoes a previous fast_pack to restore the previous information. More...

static bool	test_fast_unpack (const basis::byte_array &packed_form, int &packed_length)
	checks that the "packed_form" could hold a valid packed infoton. More...

static int	fast_pack_overhead (const structures::string_array &classifier)
	reports how much space is needed to pack the "classifier". More...

Detailed Description

Definition at line 33 of file crompish_pax.h.

Constructor & Destructor Documentation

◆ bubble()

bubble::bubble	(	int	data_segment_size = `0`,
		const structures::string_array &	boundaries = `structures::string_array()`,
		int	color = `0`
	)

inline

Definition at line 36 of file crompish_pax.h.

References reset().

Member Function Documentation

◆ bubble_classing()

const structures::string_array& bubble::bubble_classing ( ) const

inline

Definition at line 44 of file crompish_pax.h.

Referenced by text_form().

◆ clone()

virtual clonable* bubble::clone ( ) const

inlinevirtual

must be provided to allow creation of a copy of this object.

Implements octopi::infoton.

Definition at line 59 of file crompish_pax.h.

◆ data()

basis::byte_array& bubble::data ( )

inline

Definition at line 61 of file crompish_pax.h.

◆ data_length()

int bubble::data_length ( ) const

inline

Definition at line 57 of file crompish_pax.h.

References basis::array< contents >::length().

◆ non_data_overhead()

int bubble::non_data_overhead ( ) const

inline

Definition at line 63 of file crompish_pax.h.

References basis::array< contents >::length(), and packed_size().

◆ pack()

virtual void bubble::pack ( basis::byte_array & packed_form ) const

inlinevirtual

stuffs the data in the infoton into the "packed_form".

the derived method must know how to pack this particular type of infoton.

Implements octopi::infoton.

Definition at line 71 of file crompish_pax.h.

References structures::attach(), basis::text_formable::class_name(), deadly_error, FUNCDEF, basis::array< contents >::length(), structures::string_array::pack(), and packed_size().

◆ packed_size()

int bubble::packed_size ( ) const

inlinevirtual

reports how large the infoton will be when packed.

must be overridden by derived classes to provide a guess at how large the packed size of this will be. this is important to estimate accurately.

no, old. 4 * sizeof(int);

Implements octopi::infoton.

Definition at line 88 of file crompish_pax.h.

References basis::array< contents >::length(), and structures::string_array::packed_size().

Referenced by non_data_overhead(), and pack().

◆ reset()

void bubble::reset	(	int	data_segment_size,
		const structures::string_array &	boundaries,
		int	color
	)

inline

Definition at line 50 of file crompish_pax.h.

References basis::array< contents >::reset().

Referenced by bubble().

◆ text_form()

virtual void bubble::text_form ( basis::base_string & state_fill ) const

inlinevirtual

requires derived infotons to be able to show their state as a string.

Implements octopi::infoton.

Definition at line 65 of file crompish_pax.h.

References basis::base_string::assign(), bubble_classing(), basis::array< contents >::length(), basis::astring::s(), and structures::string_array::text_form().

◆ unpack()

virtual bool bubble::unpack ( basis::byte_array & packed_form )

inlinevirtual

restores an infoton from a packed form.

the unpack() method will be utilized by tentacles that support this type of object.

Implements octopi::infoton.

Definition at line 95 of file crompish_pax.h.

References structures::detach(), and structures::string_array::unpack().

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

/opt/feistymeow.org/feisty_meow/octopi/library/tests_cromp/crompish_pax.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ bubble()

Member Function Documentation

◆ bubble_classing()

◆ clone()

◆ data()

◆ data_length()

◆ non_data_overhead()

◆ pack()

◆ packed_size()

◆ reset()

◆ text_form()

◆ unpack()