DasFrame Struct Reference

Stores the definitions for a directional coordinate frame. More...

#include <das2/frame.h>

Collaboration diagram for DasFrame:

Public Member Functions
DAS_API DasFrame *	new_DasFrame (DasDesc *pParent, ubyte id, const char *sName, const char *sType)
	Create a new empty frame definition. More...
DAS_API char *	DasFrame_info (const DasFrame *pThis, char *sBuf, int nLen)
	Print a 1-line summary of a frame and then it's properties.
DAS_API DasErrCode	DasFrame_setName (DasFrame *pThis, const char *sName)
	Change the frame name.
#define	DasFrame_getName(P)   (P->name)
	Get the frame name.
DAS_API DasErrCode	DasFrame_setType (DasFrame *pThis, const char *sType)
	Set the type of the frame as a string This is almost always the constant string "cartesian".
DAS_API ubyte	DasFrame_getType (const DasFrame *pThis)
	Get the type of the frame as a string This is almost always the constant string "cartesian".
DAS_API DasErrCode	DasFrame_addDir (DasFrame *pThis, const char *sDir)
	Add a direction to a frame definition.
DAS_API const char *	DasFrame_dirByIdx (const DasFrame *pThis, int iIndex)
	Given the index of a frame direction, return it's name.
DAS_API int8_t	DasFrame_idxByDir (const DasFrame *pThis, const char *sDir)
	Givin the name of a frame direction, return it's index. More...
DAS_API void	del_DasFrame (DasFrame *pThis)
	Free a frame definition that was allocated on the heap.

Data Fields
DasDesc	base
	The base class.

Detailed Description

Stores the definitions for a directional coordinate frame.

These are little more then a basic definition to allow new das3 vector objects to be manipulated in a somewhat reasonable manner. Two vectors that hare the same coordinate system can be subject to cross-products and other useful manipulations. If the do not share a coordinate system then some out-of-band transformation will be needed.

Member Function Documentation

new_DasFrame()

DAS_API DasFrame * new_DasFrame	(	DasDesc *	pParent,
		ubyte	id,
		const char *	sName,
		const char *	sType
	)

Create a new empty frame definition.

Parameters

A	coordinate name type string, such as "cartesian"

DasFrame_idxByDir()

DAS_API int8_t DasFrame_idxByDir	(	const DasFrame *	pThis,
		const char *	sDir
	)

Givin the name of a frame direction, return it's index.

Returns

A signed byte. If the value is less then 0 then that direction is not defined

---

The documentation for this struct was generated from the following file:

• das2/frame.h