TWS Queue Functions

[English]

TWS_QUEUE API Brief

Application	Brief
tws_fsm_q_pop()	Pop FSM from queue
tws_fsm_q_insert()	Insert FSM into queue
tws_fsm_q_get_front()	Get the FSM in front of the queue
tws_fsm_q_is_empty()	Check that the queue is empty
tws_fsm_is_duplicate_fsm()	Check queue for duplicate FSM
tws_fsm_get_q()	Get FSM queue environment parameter
tws_fsm_q_init()	Initialize FSM queue

TWS_QUEUE API Reference

Header File

• tws/tws_ux/inc/tws_queue.h

Functions

tws_q_sts_t tws_fsm_q_pop(tws_fsm_q_env_t *p_fsm_q, subfsm_info_t *p_fsm)

Pop FSM from queue.

Pop FSM from the queue [p_fsm_q] to the [p_fsm].

参数:

• p_fsm_q – [in] pointer to FSM queue of type tws_fsm_q_env_t.

• p_fsm – [in] pointer to sub FSM of type subfsm_info_t.

返回:

queue status of type tws_q_sts_t

tws_q_sts_t tws_fsm_q_insert(tws_fsm_q_env_t *p_fsm_q, subfsm_info_t *p_fsm)

Insert FSM into queue.

Insert the FSM [p_fsm] into queue [p_fsm_q].

参数:

• p_fsm_q – [in] pointer to FSM queue of type tws_fsm_q_env_t.

• p_fsm – [in] pointer to sub FSM of type subfsm_info_t.

返回:

queue status of type tws_q_sts_t

tws_q_sts_t tws_fsm_q_get_front(tws_fsm_q_env_t *p_fsm_q, subfsm_info_t *p_fsm)

Get the FSM in front of the queue.

Get the FSM in front of queue [p_fsm_q] to the [p_fsm].

参数:

• p_fsm_q – [in] pointer to FSM queue of type tws_fsm_q_env_t.

• p_fsm – [in] pointer to sub FSM queue of type subfsm_info_t.

返回:

queue status of type tws_q_sts_t

bool tws_fsm_q_is_empty(tws_fsm_q_env_t *p_fsm_q)

Check that the queue is empty.

Check that the queue [p_fsm_q] is empty.

参数:

p_fsm_q – [in] pointer to FSM queue of type tws_fsm_q_env_t.

返回值:

• true – empty

• false – not empty

返回:

result

bool tws_fsm_is_duplicate_fsm(tws_fsm_q_env_t *p_fsm_q, subfsm_info_t *p_fsm)

Check queue for duplicate FSM.

Check queue [p_fsm_q] for duplicate FSM [p_fsm].

参数:

• p_fsm_q – [in] pointer to FSM queue of type tws_fsm_q_env_t.

• p_fsm – [in] pointer to sub FSM of type subfsm_info_t.

返回值:

• true – is duplicate

• false – not duplicate

返回:

result

tws_fsm_q_env_t *tws_fsm_get_q(fsm_q_type_t fsm_q_type)

Get FSM queue environment parameter.

Get FSM queue environment parameter with type [fsm_q_type].

参数:

fsm_q_type – [in] FSM queue type of type fsm_q_type_t

返回:

pointer to an FSM queue environment parameter of type tws_fsm_q_env_t.

void tws_fsm_q_init(void)

Initialize FSM queue.

Clean up the FSM queue.

返回:

N/A TWS_QUEUE_H EOF

Structures

struct tws_fsm_q_env_t

FSM environment parameters structure definition.

struct tws_fsm_q_t

FSM queue structure definition.

Macros

MAX_FSM_Q_NUM

Maximum number of FSM queues

TWS_Q_OK

TWS_Q_ERROR

TWS_Q_EMPTY

TWS_Q_FULL

TWS_FSM_Q_HIGH

TWS_FSM_Q_NORMAL

TWS_FSM_Q_LOW

Type Definitions

typedef uint8_t tws_q_sts_t

TWS queue status type definition.

typedef uint8_t fsm_q_type_t

FSM queue type definition.