GdkTool.h

Go to the documentation of this file.

/** 
 * @file    GdkTool.h
 * @brief   Declares the GdkTool class.
 *
 * Copyright (C) 2015 by LMI Technologies Inc.  All rights reserved.
 */
#ifndef GDK_TOOL_H
#define GDK_TOOL_H

#include <Gdk/GdkDef.h>
#include <Gdk/Tools/GdkToolInfo.h>
#include <Gdk/Config/GdkToolCfg.h>
#include <Gdk/Tools/GdkToolInput.h>
#include <Gdk/Tools/GdkToolOutput.h>
#include <Gdk/Utils/GdkSensorInfo.h>

kBeginHeader()

typedef struct GdkToolEnv
{
    GdkSensorInfo sensorInfo;
} GdkToolEnv;

/**
* Base class for a tool implementation.
*
* @class       GdkTool
* @extends     kObject
* @ingroup     Gdk-Tools
*/
typedef kObject GdkTool;

/**
* Returns the tool configuration.
*
* @public               @memberof GdkTool
* @param   tool         Tool object.
* @return               Current configuration object.
*/
GdkFx(GdkToolCfg) GdkTool_Config(GdkTool tool);

/**
* Returns the sensor information.
*
* @public               @memberof GdkTool
* @param   tool         Tool object.
* @return               Current sensor info.
*/
GdkFx(GdkSensorInfo) GdkTool_SensorInfo(GdkTool tool);

GdkFx(kStatus) GdkTool_Start(GdkTool tool);
GdkFx(kStatus) GdkTool_Stop(GdkTool tool);
GdkFx(kStatus) GdkTool_Process(GdkTool tool, GdkToolInput input, GdkToolOutput output);

kEndHeader()

#include <Gdk/Tools/GdkTool.x.h>

#endif