base2.h File Reference

#include "common.h"

Go to the source code of this file.

Typedefs
typedef struct base2_st_ *	base2_handle
Functions
my_rc_e	base2_increase_val1 (base2_handle base2_h)
my_rc_e	base2_get_val1 (base2_handle base2_h, uint32_t *val1)
void	base2_delete (base2_handle base2_h)
const char *	base2_type_string (base2_handle base2_h)
my_rc_e	base2_string (base2_handle base2_h, char *buffer, size_t buffer_size)
my_rc_e	base2_string_size (base2_handle base2_h, size_t *buffer_size)

---

Detailed Description

Author:

Matt Miller <matt@matthewjmiller.net>

LICENSE

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

DESCRIPTION

This is the public interface for base2 class.

Definition in file base2.h.

---

Typedef Documentation

typedef struct base2_st_* base2_handle

Opaque pointer to reference instances of this class

Definition at line 30 of file base2.h.

---

Function Documentation

void base2_delete

(

base2_handle

base2_h

)

Delete the object. This is a virtual function. Upon return, the object is not longer valid.

Parameters:

base2_h

The object. If NULL, then this function is a no-op.

Definition at line 246 of file base2.c.

my_rc_e base2_get_val1	(	base2_handle	base2_h,
		uint32_t *	val1
	)

Get the current val1 value for the object.

Parameters:

base2_h	The object
val1	Outputs the current value.

Returns:

Return code

Definition at line 285 of file base2.c.

my_rc_e base2_increase_val1

(

base2_handle

base2_h

)

Increase val3 for the object. This is a pure virtual function.

Parameters:

base2_h

The object

Returns:

Return code

Definition at line 265 of file base2.c.

my_rc_e base2_string	(	base2_handle	base2_h,
		char *	buffer,
		size_t	buffer_size
	)

Get a string representation of the object. This is a virtual function.

Parameters:

base2_h	The object
buffer	The buffer in which to put the string.
buffer_size	The size of the buffer.

Returns:

Return code

See also:

base2_string_size()

Definition at line 127 of file base2.c.

my_rc_e base2_string_size	(	base2_handle	base2_h,
		size_t *	buffer_size
	)

Get the minimum size of a string buffer that should be used to get a string representation of the object. This is a virtual function.

Parameters:

base2_h	The object
buffer_size	Outputs the size of the buffer that should be used.

Returns:

Return code

See also:

base2_string()

Definition at line 50 of file base2.c.

const char* base2_type_string

(

base2_handle

base2_h

)

Get the string describing the type of the object. This is a virtual function.

Parameters:

base2_h

The object

Returns:

The string indicating the object type.

Definition at line 105 of file base2.c.