Gocator Development Kit
 All Classes Files Functions Variables Typedefs Friends Modules Pages
GdkDataInfo.h
Go to the documentation of this file.
1 /**
2 * @file GdkDataInfo.h
3 * @brief Declares the GdkDataInfo class.
4 *
5 * Copyright (C) 2015-2022 by LMI Technologies Inc. All rights reserved.
6 */
7 #ifndef GDK_DATA_INFO_H
8 #define GDK_DATA_INFO_H
9 
10 #include <Gdk/GdkDef.h>
11 
12 /**
13 * Describes a data source.
14 *
15 * @class GdkDataInfo
16 * @extends kObject
17 * @ingroup Gdk-Utils
18 */
19 typedef kObject GdkDataInfo;
20 kDeclareClassEx(Gdk, GdkDataInfo, kObject)
21 
22 /**
23 * Returns the type of the data source.
24 *
25 * @public @memberof GdkDataInfo
26 * @param info Info object.
27 * @return Data source type.
28 */
29 GdkFx(GdkDataType) GdkDataInfo_Type(GdkDataInfo info);
30 
31 /**
32 * Returns the the data source position.
33 *
34 * @public @memberof GdkDataInfo
35 * @param info Info object.
36 * @return Data source position.
37 */
38 GdkFx(GdkDataSource) GdkDataInfo_Source(GdkDataInfo info);
39 
40 /**
41 * Returns whether or not intensity data is available.
42 *
43 * @public @memberof GdkDataInfo
44 * @param info Info object.
45 * @return Intensity presence.
46 */
47 GdkFx(kBool) GdkDataInfo_HasIntensity(GdkDataInfo info);
48 
49 /**
50 * Returns the data scales.
51 *
52 * Note: when simulating data recorded from a version older than 4.6, the scales
53 * obtained outside of the GdkTool_VProcess method may be inaccurate.
54 *
55 * @public @memberof GdkDataInfo
56 * @param info Info object.
57 * @return Data scales.
58 */
59 GdkFx(const kPoint3d64f*) GdkDataInfo_Scale(GdkDataInfo info);
60 
61 /**
62 * Returns the the data region.
63 *
64 * @public @memberof GdkDataInfo
65 * @param info Info object.
66 * @return Data region.
67 */
68 GdkFx(const GdkRegion3d64f*) GdkDataInfo_Region(GdkDataInfo info);
69 
70 /**
71 * Returns the the stream step.
72 *
73 * @public @memberof GdkDataInfo
74 * @param info Info object.
75 * @return Stream step.
76 */
77 GdkFx(k32s) GdkDataInfo_StreamStep(GdkDataInfo info);
78 
79 /**
80 * Returns the the stream ID.
81 *
82 * @public @memberof GdkDataInfo
83 * @param info Info object.
84 * @return Stream ID.
85 */
86 GdkFx(k32s) GdkDataInfo_StreamId(GdkDataInfo info);
87 
88 #endif
GdkDef.h
Essential Gdk declarations.
Gdk
Definition: GdkCfgInterfaces.h:14
GdkDataInfo::GdkDataInfo_Region
const GdkRegion3d64f * GdkDataInfo_Region(GdkDataInfo info)
Returns the the data region.
GdkDataInfo::GdkDataInfo_Type
GdkDataType GdkDataInfo_Type(GdkDataInfo info)
Returns the type of the data source.
GdkDataInfo::GdkDataInfo_Scale
const kPoint3d64f * GdkDataInfo_Scale(GdkDataInfo info)
Returns the data scales.
GdkDataInfo::GdkDataInfo_StreamId
k32s GdkDataInfo_StreamId(GdkDataInfo info)
Returns the the stream ID.
kDeclareClassEx
#define kDeclareClassEx(PREFIX, SYMBOL, BASE)
GdkDataInfo::GdkDataInfo_StreamStep
k32s GdkDataInfo_StreamStep(GdkDataInfo info)
Returns the the stream step.
GdkDataInfo
Describes a data source.
GdkDataSource
Represents a data source selection.
GdkDataType
Represents data type. No longer used as a bitmask. Note that generic data types will have their msb s...
GdkDataInfo::GdkDataInfo_HasIntensity
kBool GdkDataInfo_HasIntensity(GdkDataInfo info)
Returns whether or not intensity data is available.
GdkDataInfo::GdkDataInfo_Source
GdkDataSource GdkDataInfo_Source(GdkDataInfo info)
Returns the the data source position.