/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RtemsReqIdentLocal
 */

/*
 * Copyright (C) 2020 embedded brains GmbH & Co. KG
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * This file is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */

#ifndef _TR_OBJECT_IDENT_LOCAL_H
#define _TR_OBJECT_IDENT_LOCAL_H

#include <rtems.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @addtogroup RtemsReqIdentLocal
 *
 * @{
 */

typedef enum {
  RtemsReqIdentLocal_Pre_Name_Invalid,
  RtemsReqIdentLocal_Pre_Name_Valid,
  RtemsReqIdentLocal_Pre_Name_NA
} RtemsReqIdentLocal_Pre_Name;

typedef enum {
  RtemsReqIdentLocal_Pre_Id_Valid,
  RtemsReqIdentLocal_Pre_Id_Null,
  RtemsReqIdentLocal_Pre_Id_NA
} RtemsReqIdentLocal_Pre_Id;

typedef enum {
  RtemsReqIdentLocal_Post_Status_Ok,
  RtemsReqIdentLocal_Post_Status_InvAddr,
  RtemsReqIdentLocal_Post_Status_InvName,
  RtemsReqIdentLocal_Post_Status_NA
} RtemsReqIdentLocal_Post_Status;

typedef enum {
  RtemsReqIdentLocal_Post_Id_Nop,
  RtemsReqIdentLocal_Post_Id_Null,
  RtemsReqIdentLocal_Post_Id_Id,
  RtemsReqIdentLocal_Post_Id_NA
} RtemsReqIdentLocal_Post_Id;

/**
 * @brief Runs the parameterized test case.
 *
 * @param id_local_object is the identifier of an active object of the class
 *   under test.
 *
 * @param name_local_object is the name of the active object of the class under
 *   test.
 *
 * @param action is the action handler.
 */
void RtemsReqIdentLocal_Run(
  rtems_id             id_local_object,
  rtems_name           name_local_object,
  rtems_status_code ( *action )( rtems_name, rtems_id * )
);

/** @} */

#ifdef __cplusplus
}
#endif

#endif /* _TR_OBJECT_IDENT_LOCAL_H */