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

#include <stdint.h>
#include <stdlib.h>
#include "lcmtype.h"

#ifndef _path_ctrl_t_h
#define _path_ctrl_t_h

#ifdef __cplusplus
extern "C" {
#endif

typedef struct _path_ctrl_t path_ctrl_t;
struct _path_ctrl_t
{
    int8_t     cmd;
    int8_t     speed;
};

/**
 * Create a deep copy of a path_ctrl_t.
 * When no longer needed, destroy it with path_ctrl_t_destroy()
 */
path_ctrl_t* path_ctrl_t_copy(const path_ctrl_t* to_copy);

/**
 * Destroy an instance of path_ctrl_t created by path_ctrl_t_copy()
 */
void path_ctrl_t_destroy(path_ctrl_t* to_destroy);

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

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

/**
 * Publish a message of type path_ctrl_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 path_ctrl_t_publish(lcm_t *lcm, const char *channel, const path_ctrl_t *msg);

/**
 * Subscribe to messages of type path_ctrl_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
 */
path_ctrl_t_subscription_t* path_ctrl_t_subscribe(lcm_t *lcm, const char *channel, path_ctrl_t_handler_t handler, void *userdata);

/**
 * Removes and destroys a subscription created by path_ctrl_t_subscribe()
 */
int path_ctrl_t_unsubscribe(lcm_t *lcm, path_ctrl_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 path_ctrl_t_subscription_set_queue_capacity(path_ctrl_t_subscription_t* subs,
                              int num_messages);

/**
 * Encode a message of type path_ctrl_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 path_ctrl_t_encoded_size().
 * @param msg The message to encode.
 * @return The number of bytes encoded, or <0 if an error occured.
 */
int path_ctrl_t_encode(void *buf, int offset, int maxlen, const path_ctrl_t *p);

/**
 * Decode a message of type path_ctrl_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 path_ctrl_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 path_ctrl_t_decode(const void *buf, int offset, int maxlen, path_ctrl_t *msg);

/**
 * Release resources allocated by path_ctrl_t_decode()
 * @return 0
 */
int path_ctrl_t_decode_cleanup(path_ctrl_t *p);

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

// LCM support functions. Users should not call these
int64_t __path_ctrl_t_get_hash(void);
uint64_t __path_ctrl_t_hash_recursive(const __lcm_hash_ptr *p);
int     __path_ctrl_t_encode_array(void *buf, int offset, int maxlen, const path_ctrl_t *p, int elements);
int     __path_ctrl_t_decode_array(const void *buf, int offset, int maxlen, path_ctrl_t *p, int elements);
int     __path_ctrl_t_decode_array_cleanup(path_ctrl_t *p, int elements);
int     __path_ctrl_t_encoded_array_size(const path_ctrl_t *p, int elements);
int     __path_ctrl_t_clone_array(const path_ctrl_t *p, path_ctrl_t *q, int elements);

#ifdef __cplusplus
}
#endif

#endif