obj_ns.h File Reference

#include "obj_desc.h"
#include "idseg_val.h"
#include "idseg_ref.h"
#include "cace/ari/ref.h"
#include "cace/util/defs.h"
#include "cace/util/nocase.h"
#include <m-rbtree.h>
#include <m-shared-ptr.h>

Include dependency graph for obj_ns.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	cace_amm_obj_ns_ctr_t
	A container of object descriptors all of a single type within a namespace. More...
struct	cace_amm_obj_ns_t
	Storage of a namespace, its identifiers, and its contained objects. More...

Macros
#define	M_OPL_cace_amm_obj_ns_ctr_t()    (INIT(API_2(cace_amm_obj_ns_ctr_init)), INIT_SET(0), CLEAR(API_2(cace_amm_obj_ns_ctr_deinit)), SET(0))
#define	M_OPL_cace_amm_obj_ns_t()    (INIT(API_2(cace_amm_obj_ns_init)), INIT_SET(0), CLEAR(API_2(cace_amm_obj_ns_deinit)), SET(0))
	M*LIB oplist for cace_amm_obj_ns_t.

Typedefs
typedef struct cace_amm_obj_org_s	cace_amm_obj_org_t

Functions
void	cace_amm_obj_ns_ctr_init (cace_amm_obj_ns_ctr_t *obj)
void	cace_amm_obj_ns_ctr_deinit (cace_amm_obj_ns_ctr_t *obj)
void	cace_amm_obj_ns_init (cace_amm_obj_ns_t *ns)
void	cace_amm_obj_ns_deinit (cace_amm_obj_ns_t *ns)
cace_amm_obj_desc_t *	cace_amm_obj_ns_add_obj (cace_amm_obj_ns_t *ns, cace_ari_type_t obj_type, const cace_amm_idseg_ref_t obj_id)
cace_amm_obj_desc_t *	cace_amm_obj_ns_find_obj_name (const cace_amm_obj_ns_t *ns, cace_ari_type_t obj_type, const char *name)
cace_amm_obj_desc_t *	cace_amm_obj_ns_find_obj_enum (const cace_amm_obj_ns_t *ns, cace_ari_type_t obj_type, cace_ari_int_id_t intenum)
bool	cace_amm_obj_ns_is_match (const cace_amm_obj_ns_t *ns, cace_ari_int_id_t org_id, cace_ari_int_id_t model_id)
	Determine if the object namespace has specific enumerations.
bool	cace_amm_obj_ns_is_odm (const cace_amm_obj_ns_t *ns)
	Determine if the object namespace is an ODM.

Macro Definition Documentation

M_OPL_cace_amm_obj_ns_ctr_t

#define M_OPL_cace_amm_obj_ns_ctr_t

(

)

(INIT(API_2(cace_amm_obj_ns_ctr_init)), INIT_SET(0), CLEAR(API_2(cace_amm_obj_ns_ctr_deinit)), SET(0))

M_OPL_cace_amm_obj_ns_t

#define M_OPL_cace_amm_obj_ns_t

(

)

(INIT(API_2(cace_amm_obj_ns_init)), INIT_SET(0), CLEAR(API_2(cace_amm_obj_ns_deinit)), SET(0))

M*LIB oplist for cace_amm_obj_ns_t.

Typedef Documentation

cace_amm_obj_org_t

typedef struct cace_amm_obj_org_s cace_amm_obj_org_t

Function Documentation

cace_amm_obj_ns_add_obj()

cace_amm_obj_desc_t * cace_amm_obj_ns_add_obj	(	cace_amm_obj_ns_t *	ns,
		cace_ari_type_t	obj_type,
		const cace_amm_idseg_ref_t	obj_id
	)

References cace_amm_idseg_val_set_fromref(), cace_ari_deinit(), CACE_ARI_INIT_UNDEFINED, cace_ari_objpath_set_textid(), cace_ari_set_objref(), CACE_ARI_TEXT_ENC_OPTS_DEFAULT, cace_ari_text_encode(), CACE_LOG_DEBUG, cace_log_is_enabled_for(), CACE_LOG_WARNING, cace_amm_idseg_ref_t::has_intenum, cace_amm_idseg_val_t::has_intenum, cace_amm_idseg_ref_t::intenum, cace_amm_idseg_val_t::intenum, cace_amm_obj_ns_t::model_id, cace_amm_idseg_ref_t::name, cace_amm_idseg_val_t::name, cace_amm_obj_ns_ctr_t::obj_by_enum, cace_amm_obj_ns_ctr_t::obj_by_name, cace_amm_obj_desc_t::obj_id, cace_amm_obj_ns_ctr_t::obj_list, cace_amm_obj_ns_t::object_types, and cace_amm_obj_ns_t::org_id.

Referenced by refda_register_const(), refda_register_ctrl(), refda_register_edd(), refda_register_ident(), refda_register_oper(), refda_register_sbr(), refda_register_tbr(), refda_register_typedef(), refda_register_var(), suiteSetUp(), test_obj_ns_add_obj_duplicate(), and test_obj_ns_find_obj().

cace_amm_obj_ns_ctr_deinit()

void cace_amm_obj_ns_ctr_deinit

(

cace_amm_obj_ns_ctr_t *

obj

)

References cace_amm_obj_ns_ctr_t::obj_by_enum, cace_amm_obj_ns_ctr_t::obj_by_name, and cace_amm_obj_ns_ctr_t::obj_list.

cace_amm_obj_ns_ctr_init()

void cace_amm_obj_ns_ctr_init

(

cace_amm_obj_ns_ctr_t *

obj

)

References cace_amm_obj_ns_ctr_t::obj_by_enum, cace_amm_obj_ns_ctr_t::obj_by_name, and cace_amm_obj_ns_ctr_t::obj_list.

cace_amm_obj_ns_deinit()

void cace_amm_obj_ns_deinit

(

cace_amm_obj_ns_t *

ns

)

References cace_amm_idseg_val_deinit(), cace_ari_date_deinit(), cace_amm_obj_ns_t::feature_supp, cace_amm_obj_ns_t::model_id, cace_amm_obj_ns_t::model_rev, cace_amm_obj_ns_t::object_types, and cace_amm_obj_ns_t::org_id.

Referenced by test_obj_ns_add_obj_duplicate(), and test_obj_ns_find_obj().

cace_amm_obj_ns_find_obj_enum()

cace_amm_obj_desc_t * cace_amm_obj_ns_find_obj_enum	(	const cace_amm_obj_ns_t *	ns,
		cace_ari_type_t	obj_type,
		cace_ari_int_id_t	intenum
	)

References cace_amm_obj_ns_ctr_t::obj_by_enum, and cace_amm_obj_ns_t::object_types.

Referenced by cace_amm_lookup_deref(), refda_adm_ietf_dtnma_agent_ctrl_ensure_const(), refda_adm_ietf_dtnma_agent_ctrl_ensure_sbr(), refda_adm_ietf_dtnma_agent_ctrl_ensure_tbr(), refda_adm_ietf_dtnma_agent_ctrl_ensure_var(), and test_obj_ns_find_obj().

cace_amm_obj_ns_find_obj_name()

cace_amm_obj_desc_t * cace_amm_obj_ns_find_obj_name	(	const cace_amm_obj_ns_t *	ns,
		cace_ari_type_t	obj_type,
		const char *	name
	)

References cace_amm_obj_ns_ctr_t::obj_by_name, and cace_amm_obj_ns_t::object_types.

Referenced by cace_amm_lookup_deref(), refda_adm_ietf_dtnma_agent_ctrl_ensure_const(), refda_adm_ietf_dtnma_agent_ctrl_ensure_sbr(), refda_adm_ietf_dtnma_agent_ctrl_ensure_tbr(), refda_adm_ietf_dtnma_agent_ctrl_ensure_var(), and test_obj_ns_find_obj().

cace_amm_obj_ns_init()

void cace_amm_obj_ns_init

(

cace_amm_obj_ns_t *

ns

)

References cace_amm_idseg_val_init(), cace_ari_date_init(), cace_amm_obj_ns_t::feature_supp, cace_amm_obj_ns_t::model_id, cace_amm_obj_ns_t::model_rev, cace_amm_obj_ns_t::object_types, cace_amm_obj_ns_t::obsolete, and cace_amm_obj_ns_t::org_id.

Referenced by test_obj_ns_add_obj_duplicate(), and test_obj_ns_find_obj().

cace_amm_obj_ns_is_match()

bool cace_amm_obj_ns_is_match	(	const cace_amm_obj_ns_t *	ns,
		cace_ari_int_id_t	org_id,
		cace_ari_int_id_t	model_id
	)

Determine if the object namespace has specific enumerations.

Parameters

[in]	The	namespace to inspect.
	org_id	The organization enumeration.
	model_id	The model enumeration.

Returns

True if the namespace has the given identifiers.

References CHKFALSE, cace_amm_idseg_val_t::has_intenum, cace_amm_idseg_val_t::intenum, cace_amm_obj_ns_t::model_id, and cace_amm_obj_ns_t::org_id.

Referenced by cace_amm_type_set_name_semtype().

cace_amm_obj_ns_is_odm()

bool cace_amm_obj_ns_is_odm

(

const cace_amm_obj_ns_t *

ns

)

Determine if the object namespace is an ODM.

Parameters

[in]

The

namespace to inspect.

Returns

True if the namespace is an ODM, false otherwise.

References CHKFALSE, cace_amm_idseg_val_t::has_intenum, cace_amm_idseg_val_t::intenum, cace_amm_obj_ns_t::model_id, and cace_amm_idseg_val_t::name.

Referenced by refda_adm_ietf_dtnma_agent_ctrl_ensure_const(), refda_adm_ietf_dtnma_agent_ctrl_ensure_tbr(), refda_adm_ietf_dtnma_agent_ctrl_ensure_var(), refda_adm_ietf_dtnma_agent_ctrl_obsolete_const(), refda_adm_ietf_dtnma_agent_ctrl_obsolete_rule(), and refda_adm_ietf_dtnma_agent_ctrl_obsolete_var().