Database Objects

Collaboration diagram for Database Objects:

Files
file	objects.h

Macros
#define	GED_CHECK_COMB(_gedp, _dp, _flags)
#define	GED_CHECK_EXISTS(_gedp, _name, _noisy, _flags)
#define	GED_CHECK_READ_ONLY(_gedp, _flags)
#define	GED_CHECK_REGION(_gedp, _dp, _flags)
#define	GED_DB_DIRADD(_gedp, _dp, _name, _laddr, _len, _dirflags, _ptr, _flags)
#define	GED_DB_LOOKUP(_gedp, _dp, _name, _noisy, _flags)
#define	GED_DB_GET_INTERNAL(_gedp, _intern, _dp, _mat, _resource, _flags)
#define	GED_DB_PUT_INTERNAL(_gedp, _dp, _intern, _resource, _flags)

Detailed Description

Geometry EDiting Library Database Generic Object Functions.

These are functions that operate on database objects.

Macro Definition Documentation

GED_CHECK_COMB

#define GED_CHECK_COMB	(		_gedp,
			_dp,
			_flags
	)

Value:

    if (((_dp)->d_flags & RT_DIR_COMB) == 0) { \
        int ged_check_comb_quiet = (_flags) & GED_QUIET; \
	if (!ged_check_comb_quiet) { \
	    bu_vls_printf((_gedp)->ged_result_str, "%s is not a combination", (_dp)->d_namep); \
        } \
	return (_flags); \
    }

Check if the object is a combination

Definition at line 38 of file objects.h.

GED_CHECK_EXISTS

#define GED_CHECK_EXISTS	(		_gedp,
			_name,
			_noisy,
			_flags
	)

Value:

    if (db_lookup((_gedp)->dbip, (_name), (_noisy)) != RT_DIR_NULL) { \
        int ged_check_exists_quiet = (_flags) & GED_QUIET; \
	if (!ged_check_exists_quiet) { \
	    bu_vls_printf((_gedp)->ged_result_str, "%s already exists.", (_name)); \
        } \
	return (_flags); \
    }

Lookup database object

Definition at line 48 of file objects.h.

GED_CHECK_READ_ONLY

#define GED_CHECK_READ_ONLY	(		_gedp,
			_flags
	)

Value:

    if ((_gedp)->dbip->dbi_read_only) { \
        int ged_check_read_only_quiet = (_flags) & GED_QUIET; \
	if (!ged_check_read_only_quiet) { \
	    bu_vls_trunc((_gedp)->ged_result_str, 0); \
	    bu_vls_printf((_gedp)->ged_result_str, "Sorry, this database is READ-ONLY."); \
        } \
	return (_flags); \
    }

Check if the database is read only

Definition at line 58 of file objects.h.

GED_CHECK_REGION

#define GED_CHECK_REGION	(		_gedp,
			_dp,
			_flags
	)

Value:

    if (((_dp)->d_flags & RT_DIR_REGION) == 0) { \
        int ged_check_region_quiet = (_flags) & GED_QUIET; \
	if (!ged_check_region_quiet) { \
	    bu_vls_printf((_gedp)->ged_result_str, "%s is not a region.", (_dp)->d_namep); \
        } \
	return (_flags); \
    }

Check if the object is a region

Definition at line 69 of file objects.h.

GED_DB_DIRADD

#define GED_DB_DIRADD	(		_gedp,
			_dp,
			_name,
			_laddr,
			_len,
			_dirflags,
			_ptr,
			_flags
	)

Value:

    if (((_dp) = db_diradd((_gedp)->dbip, (_name), (_laddr), (_len), (_dirflags), (_ptr))) == RT_DIR_NULL) { \
        int ged_db_diradd_quiet = (_flags) & GED_QUIET; \
	if (!ged_db_diradd_quiet) { \
	    bu_vls_printf((_gedp)->ged_result_str, "Unable to add %s to the database.", (_name)); \
        } \
	return (_flags); \
    }

add a new directory entry to the currently open database

Definition at line 79 of file objects.h.

GED_DB_LOOKUP

#define GED_DB_LOOKUP	(		_gedp,
			_dp,
			_name,
			_noisy,
			_flags
	)

Value:

    if (((_dp) = db_lookup((_gedp)->dbip, (_name), (_noisy))) == RT_DIR_NULL) { \
        int ged_db_lookup_quiet = (_flags) & GED_QUIET; \
	if (!ged_db_lookup_quiet) { \
	    bu_vls_printf((_gedp)->ged_result_str, "Unable to find %s in the database.", (_name)); \
        } \
	return (_flags); \
    }

Lookup database object

Definition at line 89 of file objects.h.

GED_DB_GET_INTERNAL

#define GED_DB_GET_INTERNAL	(		_gedp,
			_intern,
			_dp,
			_mat,
			_resource,
			_flags
	)

Value:

    if (rt_db_get_internal((_intern), (_dp), (_gedp)->dbip, (_mat), (_resource)) < 0) { \
        int ged_db_get_internal_quiet = (_flags) & GED_QUIET; \
	if (!ged_db_get_internal_quiet) { \
	    bu_vls_printf((_gedp)->ged_result_str, "Database read failure."); \
        } \
	return (_flags); \
    }

Get internal representation

Definition at line 99 of file objects.h.

GED_DB_PUT_INTERNAL

#define GED_DB_PUT_INTERNAL	(		_gedp,
			_dp,
			_intern,
			_resource,
			_flags
	)

Value:

    if (rt_db_put_internal((_dp), (_gedp)->dbip, (_intern), (_resource)) < 0) { \
       int ged_db_put_internal_quiet = (_flags) & GED_QUIET; \
       if (!ged_db_put_internal_quiet) { \
           bu_vls_printf((_gedp)->ged_result_str, "Database write failure."); \
       } \
       return (_flags); \
    }

Put internal representation

Definition at line 109 of file objects.h.