DTNMA Reference Tools v2.0.0 - 9.gaff6489
Delay-Tolerant Networking Management Architecture (DTNMA) Tool Suite
Loading...
Searching...
No Matches
cace_ari_translator_t Struct Reference

Function pointers to implement the cace_ari_translate() behavior. More...

#include <algo.h>

+ Collaboration diagram for cace_ari_translator_t:

Data Fields

int(* map_ari )(cace_ari_t *out, const cace_ari_t *in, const cace_ari_translate_ctx_t *ctx)
 Called when translating each ARI.
 
int(* map_objpath )(cace_ari_objpath_t *out, const cace_ari_objpath_t *in, const cace_ari_translate_ctx_t *ctx)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. If not provided, the standard cace_ari_objpath_copy() will be used.
 
int(* map_lit )(cace_ari_lit_t *out, const cace_ari_lit_t *in, const cace_ari_translate_ctx_t *ctx)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. If not provided, the standard cace_ari_lit_copy() will be used.
 

Detailed Description

Function pointers to implement the cace_ari_translate() behavior.

For any input value, the map_ari is first called (with fallback behavior) followed by either map_objpath or map_lit depending on the ARI type.

Field Documentation

◆ map_ari

int(* cace_ari_translator_t::map_ari) (cace_ari_t *out, const cace_ari_t *in, const cace_ari_translate_ctx_t *ctx)

Called when translating each ARI.

For containers this is called before any contained values. If not provided, the literal/objref tag will be copied.

Precondition
The out value is already initialized.
Parameters
[out]outThe produced value.
[in]inThe value being mapped.
[in]ctxVisitor context information.
Returns
Zero to continue iterating, or non-zero to stop immediately.

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