Property documentation of mock

Properties

Details

"name" : gchararray : Read-only

Name of the camera

sensor-width

"sensor-width" : guint : Read-only

Width of the sensor in pixels

sensor-height

"sensor-height" : guint : Read-only

Height of the sensor in pixels

sensor-bitdepth

"sensor-bitdepth" : guint : Read-only

Number of bits per pixel

sensor-horizontal-binning

"sensor-horizontal-binning" : guint : Read / Write

Number of sensor ADCs that are combined to one pixel in horizontal direction

sensor-horizontal-binnings

"sensor-horizontal-binnings" : GValueArray : Read-only

Array of possible binnings in horizontal direction

sensor-vertical-binning

"sensor-vertical-binning" : guint : Read / Write

Number of sensor ADCs that are combined to one pixel in vertical direction

sensor-vertical-binnings

"sensor-vertical-binnings" : GValueArray : Read-only

Array of possible binnings in vertical direction

sensor-max-frame-rate

"sensor-max-frame-rate" : gfloat : Read-only

Maximum frame rate at full frame resolution

trigger-mode

"trigger-mode" : UcaCameraTrigger : Read / Write

Trigger mode

exposure-time

"exposure-time" : gdouble : Read / Write

Exposure time in seconds

roi-x0

"roi-x0" : guint : Read / Write

Horizontal coordinate

roi-y0

"roi-y0" : guint : Read / Write

Vertical coordinate

roi-width

"roi-width" : guint : Read / Write

Width of the region of interest

roi-height

"roi-height" : guint : Read / Write

Height of the region of interest

roi-width-multiplier

"roi-width-multiplier" : guint : Read-only

Minimum possible step size of horizontal ROI

roi-height-multiplier

"roi-height-multiplier" : guint : Read-only

Minimum possible step size of vertical ROI

has-streaming

"has-streaming" : gboolean : Read-only

Is the camera able to stream the data

has-camram-recording

"has-camram-recording" : gboolean : Read-only

Is the camera able to record the data in-camera

transfer-asynchronously

"transfer-asynchronously" : gboolean : Read / Write

Specify whether data should be transfered asynchronously using a specified callback

is-recording

"is-recording" : gboolean : Read-only

Is the camera currently recording

is-readout

"is-readout" : gboolean : Read-only

Is camera in readout mode

frame-rate

"frame-rate" : gfloat : Read / Write

Number of frames per second that are taken

diff --git a/docs/style.css b/docs/style.css index 646a097..beccf45 100644 --- a/docs/style.css +++ b/docs/style.css @@ -126,6 +126,10 @@ ul, ol { margin-bottom: 24px; } +ul#toc { + list-style-type: none; +} + li + li { margin-top: 0.1em; } diff --git a/tools/CMakeLists.txt b/tools/CMakeLists.txt new file mode 100644 index 0000000..957fdbf --- /dev/null +++ b/tools/CMakeLists.txt @@ -0,0 +1,24 @@ +cmake_minimum_required(VERSION 2.8) + +add_definitions("--std=c99 -Wall") + +# --- Find packages and libraries --------------------------------------------- +find_package(PkgConfig) + +pkg_check_modules(GLIB2 glib-2.0>=2.24 REQUIRED) +pkg_check_modules(GOBJECT2 gobject-2.0>=2.24 REQUIRED) + +# --- Build targets ----------------------------------------------------------- +include_directories( + ${GLIB2_INCLUDE_DIRS} + ${GOBJECT2_INCLUDE_DIRS} + ${CMAKE_CURRENT_BINARY_DIR}/../src/ + ${CMAKE_CURRENT_SOURCE_DIR}/../src + ) + +add_executable(gen-doc gen-doc.c) + +target_link_libraries(gen-doc uca + ${GLIB2_LIBRARIES} + ${GOBJECT2_LIBRARIES} + ) diff --git a/tools/gen-doc.c b/tools/gen-doc.c new file mode 100644 index 0000000..d9b6b41 --- /dev/null +++ b/tools/gen-doc.c @@ -0,0 +1,151 @@ +/* Copyright (C) 2012 Matthias Vogelgesang + (Karlsruhe Institute of Technology) + + This library is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as published by the + Free Software Foundation; either version 2.1 of the License, or (at your + option) any later version. + + This library 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 along + with this library; if not, write to the Free Software Foundation, Inc., 51 + Franklin St, Fifth Floor, Boston, MA 02110, USA */ + +#include +#include "uca-plugin-manager.h" +#include "uca-camera.h" + + +static void +print_usage (void) +{ + GList *types; + UcaPluginManager *manager; + + manager = uca_plugin_manager_new (); + g_print ("Usage: gen-doc [ "); + types = uca_plugin_manager_get_available_cameras (manager); + + if (types == NULL) { + g_print ("] -- no camera plugin found\n"); + return; + } + + for (GList *it = g_list_first (types); it != NULL; it = g_list_next (it)) { + gchar *name = (gchar *) it->data; + if (g_list_next (it) == NULL) + g_print ("%s ]\n", name); + else + g_print ("%s, ", name); + } +} + +static const gchar * +get_flags_description (GParamSpec *pspec) +{ + static const gchar *descriptions[] = { + "", + "Read-only", + "Write-only", + "Read / Write", + "" + }; + + if (pspec->flags >= 3) + return descriptions[3]; + + return descriptions[pspec->flags]; +} + +static void +print_property_toc (GParamSpec **pspecs, guint n_props) +{ + g_print ("

Properties

\"%s\"

"); +} + +static void +print_property_descriptions (GParamSpec **pspecs, guint n_props) +{ + g_print ("

Details

%s

"); + g_print ("

\"%s\" : %s : %s

\n", + name, + g_type_name (pspec->value_type), + get_flags_description (pspec)); + g_print ("

\n", g_param_spec_get_blurb (pspec)); + g_print ("

"); +} + +static void +print_properties (UcaCamera *camera) +{ + GObjectClass *oclass; + GParamSpec **pspecs; + guint n_props; + + oclass = G_OBJECT_GET_CLASS (camera); + pspecs = g_object_class_list_properties (oclass, &n_props); + + print_property_toc (pspecs, n_props); + print_property_descriptions (pspecs, n_props); + + g_free (pspecs); +} + +static const gchar *html_header = "\ +\ +\ +%s — properties"; +static const gchar *html_footer = ""; + +int main(int argc, char *argv[]) +{ + UcaPluginManager *manager; + UcaCamera *camera; + GError *error = NULL; + + g_type_init(); + + if (argc < 2) { + print_usage(); + return 1; + } + + manager = uca_plugin_manager_new (); + camera = uca_plugin_manager_new_camera (manager, argv[1], &error); + + if (camera == NULL) { + g_print("Error during initialization: %s\n", error->message); + return 1; + } + + g_print (html_header, argv[1]); + g_print ("

Property documentation of mock

Properties

Details

Properties

Details

Property documentation of %s