exlcm_location_t.h

// THIS IS AN AUTOMATICALLY GENERATED FILE.  DO NOT MODIFY
// BY HAND!!
//
// Generated by lcm-gen

#include <stdint.h>
#include <stdlib.h>
#include <lcm/lcm_coretypes.h>
#include <lcm/lcm.h>

#ifndef _exlcm_location_t_h
#define _exlcm_location_t_h

#ifdef __cplusplus
extern "C" {
#endif

typedef struct _exlcm_location_t exlcm_location_t;
struct _exlcm_location_t
{
    int64_t    timestampLogical;
    int64_t    timestampMS;
    int64_t    pid;
    double     position[3];
    double     velocity[3];
    double     destination[3];
};

/**
 * Create a deep copy of a exlcm_location_t.
 * When no longer needed, destroy it with exlcm_location_t_destroy()
 */
exlcm_location_t* exlcm_location_t_copy(const exlcm_location_t* to_copy);

/**
 * Destroy an instance of exlcm_location_t created by exlcm_location_t_copy()
 */
void exlcm_location_t_destroy(exlcm_location_t* to_destroy);

/**
 * Identifies a single subscription.  This is an opaque data type.
 */
typedef struct _exlcm_location_t_subscription_t exlcm_location_t_subscription_t;

/**
 * Prototype for a callback function invoked when a message of type
 * exlcm_location_t is received.
 */
typedef void(*exlcm_location_t_handler_t)(const lcm_recv_buf_t *rbuf,
             const char *channel, const exlcm_location_t *msg, void *userdata);

/**
 * Publish a message of type exlcm_location_t using LCM.
 *
 * @param lcm The LCM instance to publish with.
 * @param channel The channel to publish on.
 * @param msg The message to publish.
 * @return 0 on success, <0 on error.  Success means LCM has transferred
 * responsibility of the message data to the OS.
 */
int exlcm_location_t_publish(lcm_t *lcm, const char *channel, const exlcm_location_t *msg);

/**
 * Subscribe to messages of type exlcm_location_t using LCM.
 *
 * @param lcm The LCM instance to subscribe with.
 * @param channel The channel to subscribe to.
 * @param handler The callback function invoked by LCM when a message is received.
 *                This function is invoked by LCM during calls to lcm_handle() and
 *                lcm_handle_timeout().
 * @param userdata An opaque pointer passed to @p handler when it is invoked.
 * @return 0 on success, <0 if an error occured
 */
exlcm_location_t_subscription_t* exlcm_location_t_subscribe(lcm_t *lcm, const char *channel, exlcm_location_t_handler_t handler, void *userdata);

/**
 * Removes and destroys a subscription created by exlcm_location_t_subscribe()
 */
int exlcm_location_t_unsubscribe(lcm_t *lcm, exlcm_location_t_subscription_t* hid);

/**
 * Sets the queue capacity for a subscription.
 * Some LCM providers (e.g., the default multicast provider) are implemented
 * using a background receive thread that constantly revceives messages from
 * the network.  As these messages are received, they are buffered on
 * per-subscription queues until dispatched by lcm_handle().  This function
 * how many messages are queued before dropping messages.
 *
 * @param subs the subscription to modify.
 * @param num_messages The maximum number of messages to queue
 *  on the subscription.
 * @return 0 on success, <0 if an error occured
 */
int exlcm_location_t_subscription_set_queue_capacity(exlcm_location_t_subscription_t* subs,
                              int num_messages);

/**
 * Encode a message of type exlcm_location_t into binary form.
 *
 * @param buf The output buffer.
 * @param offset Encoding starts at this byte offset into @p buf.
 * @param maxlen Maximum number of bytes to write.  This should generally
 *               be equal to exlcm_location_t_encoded_size().
 * @param msg The message to encode.
 * @return The number of bytes encoded, or <0 if an error occured.
 */
int exlcm_location_t_encode(void *buf, int offset, int maxlen, const exlcm_location_t *p);

/**
 * Decode a message of type exlcm_location_t from binary form.
 * When decoding messages containing strings or variable-length arrays, this
 * function may allocate memory.  When finished with the decoded message,
 * release allocated resources with exlcm_location_t_decode_cleanup().
 *
 * @param buf The buffer containing the encoded message
 * @param offset The byte offset into @p buf where the encoded message starts.
 * @param maxlen The maximum number of bytes to read while decoding.
 * @param msg Output parameter where the decoded message is stored
 * @return The number of bytes decoded, or <0 if an error occured.
 */
int exlcm_location_t_decode(const void *buf, int offset, int maxlen, exlcm_location_t *msg);

/**
 * Release resources allocated by exlcm_location_t_decode()
 * @return 0
 */
int exlcm_location_t_decode_cleanup(exlcm_location_t *p);

/**
 * Check how many bytes are required to encode a message of type exlcm_location_t
 */
int exlcm_location_t_encoded_size(const exlcm_location_t *p);

// LCM support functions. Users should not call these
int64_t __exlcm_location_t_get_hash(void);
uint64_t __exlcm_location_t_hash_recursive(const __lcm_hash_ptr *p);
int     __exlcm_location_t_encode_array(void *buf, int offset, int maxlen, const exlcm_location_t *p, int elements);
int     __exlcm_location_t_decode_array(const void *buf, int offset, int maxlen, exlcm_location_t *p, int elements);
int     __exlcm_location_t_decode_array_cleanup(exlcm_location_t *p, int elements);
int     __exlcm_location_t_encoded_array_size(const exlcm_location_t *p, int elements);
int     __exlcm_location_t_clone_array(const exlcm_location_t *p, exlcm_location_t *q, int elements);

#ifdef __cplusplus
}
#endif

#endif