frame.h

Go to the documentation of this file.

/* Copyright (C) 2024 Chris Piker <chris-piker@uiowa.edu>
 *
 * This file is part of das2C, the Core Das C Library.
 * 
 * Das2C is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * Das2C is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
 * more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 2.1 along with Das2C; if not, see <http://www.gnu.org/licenses/>. 
 */
 
#ifndef _frame_h_
#define _frame_h_
 
#include <das2/descriptor.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DASFRM_NAME_SZ  64
#define DASFRM_DNAM_SZ  32
#define DASFRM_TYPE_SZ  32
#define DASFRM_MAX_DIRS  4
 
#define DASFRM_TYPE_MASK      0x0000000F
#define DASFRM_UNKNOWN        0x00000000
#define DASFRM_CARTESIAN      0x00000001
#define DASFRM_POLAR          0x00000003
#define DASFRM_SPHERE_SURFACE 0x00000002
#define DASFRM_CYLINDRICAL    0x00000004
#define DASFRM_SPHERICAL      0x00000005
 
#define DASFRM_INERTIAL       0x00000010
 
 
typedef struct frame_descriptor{
 
   DasDesc base;
 
   /* Required properties */
   ubyte id;  /* The frame ID, used in vectors, quaternions etc. */
   char name[DASFRM_NAME_SZ];
   char type[DASFRM_TYPE_SZ];
   uint32_t flags;  /* Usually contains the type */
 
   char dirs[DASFRM_MAX_DIRS][DASFRM_DNAM_SZ];
   uint32_t ndirs;
 
} DasFrame;
 
DAS_API DasFrame* new_DasFrame(
   DasDesc* pParent, ubyte id, const char* sName, const char* sType
);
 
DAS_API char* DasFrame_info(const DasFrame* pThis, char* sBuf, int nLen);
 
DAS_API DasErrCode DasFrame_setName(
   DasFrame* pThis, const char* sName
);
 
#define DasFrame_id(p) ((p)->id)
 
 
DAS_API void DasFrame_inertial(DasFrame* pThis, bool bInertial);
 
#define DasFrame_isInertial(P) (P->flags & DASFRM_INERTIAL)
 
#define DasFrame_getName(P) (P->name)
 
DAS_API DasErrCode DasFrame_setType(DasFrame* pThis, const char* sType);
 
 
DAS_API ubyte DasFrame_getType(const DasFrame* pThis);
 
 
DAS_API DasErrCode DasFrame_addDir(DasFrame* pThis, const char* sDir);
 
DAS_API const char* DasFrame_dirByIdx(const DasFrame* pThis, int iIndex);
 
DAS_API int8_t DasFrame_idxByDir(const DasFrame* pThis, const char* sDir);
 
DAS_API void del_DasFrame(DasFrame* pThis);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _frame_h_ */