foxBMS - Unit Tests  1.2.0
The foxBMS Unit Tests API Documentation
fstd_types.h File Reference

Definition of foxBMS standard types. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define NULL_PTR   ((void *)(0))
 Null pointer. More...
 

Typedefs

typedef enum STD_RETURN_TYPE STD_RETURN_TYPE_e
 

Enumerations

enum  STD_RETURN_TYPE { STD_OK , STD_NOT_OK }
 

Detailed Description

Definition of foxBMS standard types.

SPDX-License-Identifier: BSD-3-Clause

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.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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 HOLDER 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.

We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:

  • ″This product uses parts of foxBMS®″
  • ″This product includes parts of foxBMS®″
  • ″This product is derived from foxBMS®″
Author
foxBMS Team
Date
2015-12-20 (date of creation)
Updated
2020-04-02 (date of last update)
Prefix
STD

Definition in file fstd_types.h.

Macro Definition Documentation

◆ NULL_PTR

#define NULL_PTR   ((void *)(0))

Null pointer.

This define describes a null pointer. Use it to compare for null pointer access.

Definition at line 66 of file fstd_types.h.

Typedef Documentation

◆ STD_RETURN_TYPE_e

enum for standard return type

Enumeration Type Documentation

◆ STD_RETURN_TYPE

enum for standard return type

Enumerator
STD_OK 

ok

STD_NOT_OK 

not ok

Definition at line 71 of file fstd_types.h.