File: structoval__entity.tex

package info (click to toggle)
openscap 0.5.12-3
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 27,052 kB
  • ctags: 21,075
  • sloc: xml: 82,351; ansic: 52,101; sh: 17,802; makefile: 748; perl: 442; cpp: 117; python: 110
file content (174 lines) | stat: -rw-r--r-- 10,493 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
\hypertarget{structoval__entity}{
\section{oval\_\-entity Struct Reference}
\label{structoval__entity}\index{oval\_\-entity@{oval\_\-entity}}
}


OVAL entity.  


{\ttfamily \#include $<$oval\_\-definitions.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{group__OVALDEF_ga80eb2d54e2448319112517544410b3b2}{
struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$ {\bfseries oval\_\-entity\_\-new} (struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$)}
\label{group__OVALDEF_ga80eb2d54e2448319112517544410b3b2}

\item 
struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$ \hyperlink{group__OVALDEF_ga7aa93ac83325d4e43faff3f1a74a97db}{oval\_\-entity\_\-clone} (struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$model, struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$old\_\-entity)
\item 
\hypertarget{group__OVALDEF_gad55792ea550c8eda41839b7e456df093}{
void {\bfseries oval\_\-entity\_\-free} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$)}
\label{group__OVALDEF_gad55792ea550c8eda41839b7e456df093}

\end{DoxyCompactItemize}
\begin{Indent}{\bf Setters}\par
{\em \label{_amgrp6e47466b75bb957a603aa54c079ac8bf}
 }\begin{DoxyCompactItemize}
\item 
\hypertarget{group__OVALDEF_ga62129c97442d3e39cbd998495605d610}{
void {\bfseries oval\_\-entity\_\-set\_\-type} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$, \hyperlink{group__OVALDEF_gac9a4faa0d289b6b2dabb76d43b03b671}{oval\_\-entity\_\-type\_\-t})}
\label{group__OVALDEF_ga62129c97442d3e39cbd998495605d610}

\item 
\hypertarget{group__OVALDEF_ga70e69756b8ebd5a36414d49c3d58b09c}{
void {\bfseries oval\_\-entity\_\-set\_\-datatype} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$, \hyperlink{group__OVALDEF_gaf069fe2fb2a9ae3abe47cab55b89827e}{oval\_\-datatype\_\-t})}
\label{group__OVALDEF_ga70e69756b8ebd5a36414d49c3d58b09c}

\item 
\hypertarget{group__OVALDEF_ga6b672fbf30c7c265e2770f67fea1895a}{
void {\bfseries oval\_\-entity\_\-set\_\-mask} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$, int)}
\label{group__OVALDEF_ga6b672fbf30c7c265e2770f67fea1895a}

\item 
\hypertarget{group__OVALDEF_ga736f0b0cf2a151c8563b6113c3036365}{
void {\bfseries oval\_\-entity\_\-set\_\-varref\_\-type} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$, \hyperlink{group__OVALDEF_gaf188be33624f01de2946ce6e58b6bf53}{oval\_\-entity\_\-varref\_\-type\_\-t})}
\label{group__OVALDEF_ga736f0b0cf2a151c8563b6113c3036365}

\item 
\hypertarget{group__OVALDEF_ga5cf3a420a07e6562668ddb6df19ce4bc}{
void {\bfseries oval\_\-entity\_\-set\_\-variable} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$, struct \hyperlink{structoval__variable}{oval\_\-variable} $\ast$)}
\label{group__OVALDEF_ga5cf3a420a07e6562668ddb6df19ce4bc}

\item 
\hypertarget{group__OVALDEF_ga79e318b7f27d0cc558af8153ad53474d}{
void {\bfseries oval\_\-entity\_\-set\_\-value} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$, struct \hyperlink{structoval__value}{oval\_\-value} $\ast$)}
\label{group__OVALDEF_ga79e318b7f27d0cc558af8153ad53474d}

\item 
\hypertarget{group__OVALDEF_ga1cbc0afb10e52caaf287da1e4cb79fa1}{
void {\bfseries oval\_\-entity\_\-set\_\-name} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$, char $\ast$)}
\label{group__OVALDEF_ga1cbc0afb10e52caaf287da1e4cb79fa1}

\item 
\hypertarget{group__OVALDEF_ga3a51d3e90396c6e18bd730c4d7223947}{
void {\bfseries oval\_\-entity\_\-set\_\-operation} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$, \hyperlink{group__OVALDEF_ga3f00a63428c2b5db781a9c87ec73acd1}{oval\_\-operation\_\-t})}
\label{group__OVALDEF_ga3a51d3e90396c6e18bd730c4d7223947}

\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Getters}\par
{\em \label{_amgrpc9fd0bcb5385a65354c37f1bb504399d}
 }\begin{DoxyCompactItemize}
\item 
char $\ast$ \hyperlink{group__OVALDEF_ga4e9767a32b9ce04039c055c699bfce87}{oval\_\-entity\_\-get\_\-name} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$)
\begin{DoxyCompactList}\small\item\em Get OVAL entity name. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_ga012549e87cecbcb4775dbfe8cc394012}{
\hyperlink{group__OVALDEF_gac9a4faa0d289b6b2dabb76d43b03b671}{oval\_\-entity\_\-type\_\-t} \hyperlink{group__OVALDEF_ga012549e87cecbcb4775dbfe8cc394012}{oval\_\-entity\_\-get\_\-type} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$)}
\label{group__OVALDEF_ga012549e87cecbcb4775dbfe8cc394012}

\begin{DoxyCompactList}\small\item\em Get OVAL entity type. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_ga410c12432ef6b3b2ef2913f7fa77df02}{
\hyperlink{group__OVALDEF_gaf069fe2fb2a9ae3abe47cab55b89827e}{oval\_\-datatype\_\-t} \hyperlink{group__OVALDEF_ga410c12432ef6b3b2ef2913f7fa77df02}{oval\_\-entity\_\-get\_\-datatype} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$)}
\label{group__OVALDEF_ga410c12432ef6b3b2ef2913f7fa77df02}

\begin{DoxyCompactList}\small\item\em Get OVAL entity datatype. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_ga06dbde65d8560c1b02d812d333e0bf05}{
\hyperlink{group__OVALDEF_ga3f00a63428c2b5db781a9c87ec73acd1}{oval\_\-operation\_\-t} \hyperlink{group__OVALDEF_ga06dbde65d8560c1b02d812d333e0bf05}{oval\_\-entity\_\-get\_\-operation} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$)}
\label{group__OVALDEF_ga06dbde65d8560c1b02d812d333e0bf05}

\begin{DoxyCompactList}\small\item\em Get OVAL entity operation type. \item\end{DoxyCompactList}\item 
struct \hyperlink{structoval__variable}{oval\_\-variable} $\ast$ \hyperlink{group__OVALDEF_ga8fac7405ec41226f0d22e46e1b360ec8}{oval\_\-entity\_\-get\_\-variable} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$)
\begin{DoxyCompactList}\small\item\em Get OVAL entity varref variable. \item\end{DoxyCompactList}\item 
struct \hyperlink{structoval__value}{oval\_\-value} $\ast$ \hyperlink{group__OVALDEF_ga802ecb19ae32ee7a054a13e2c69ef12f}{oval\_\-entity\_\-get\_\-value} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$)
\begin{DoxyCompactList}\small\item\em Get OVAL entity value. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_ga0bc760d469082dd92f11b78c52f911d4}{
int \hyperlink{group__OVALDEF_ga0bc760d469082dd92f11b78c52f911d4}{oval\_\-entity\_\-get\_\-mask} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$)}
\label{group__OVALDEF_ga0bc760d469082dd92f11b78c52f911d4}

\begin{DoxyCompactList}\small\item\em Get OVAL entity mask. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALDEF_ga2012e8b61b18c6ca0b7f793067e40106}{
\hyperlink{group__OVALDEF_gaf188be33624f01de2946ce6e58b6bf53}{oval\_\-entity\_\-varref\_\-type\_\-t} \hyperlink{group__OVALDEF_ga2012e8b61b18c6ca0b7f793067e40106}{oval\_\-entity\_\-get\_\-varref\_\-type} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$)}
\label{group__OVALDEF_ga2012e8b61b18c6ca0b7f793067e40106}

\begin{DoxyCompactList}\small\item\em Get OVAL entity varref type. \item\end{DoxyCompactList}\item 
bool \hyperlink{group__OVALDEF_ga3cf6fb0238e19859c42ceb3a9249daa1}{oval\_\-entity\_\-is\_\-locked} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$entity)
\begin{DoxyCompactList}\small\item\em return {\bfseries true} if the entity instance is locked. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Evaluators}\par
{\em \label{_amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2}
 }\begin{DoxyCompactItemize}
\item 
\hypertarget{group__OVALDEF_gaf40cad1540a114ecc9452dce2acdd2cf}{
bool \hyperlink{group__OVALDEF_gaf40cad1540a114ecc9452dce2acdd2cf}{oval\_\-entity\_\-is\_\-valid} (struct \hyperlink{structoval__entity}{oval\_\-entity} $\ast$entity)}
\label{group__OVALDEF_gaf40cad1540a114ecc9452dce2acdd2cf}

\begin{DoxyCompactList}\small\item\em Return {\bfseries true} if the entity instance is valid. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item 
\hypertarget{structoval__entity_a90de402de978e6c8eba6e9dcca4437bf}{
struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$ {\bfseries model}}
\label{structoval__entity_a90de402de978e6c8eba6e9dcca4437bf}

\item 
\hypertarget{structoval__entity_a363c1221cb1bc889b4a43bb6c3e04eab}{
\hyperlink{group__OVALDEF_gac9a4faa0d289b6b2dabb76d43b03b671}{oval\_\-entity\_\-type\_\-t} {\bfseries type}}
\label{structoval__entity_a363c1221cb1bc889b4a43bb6c3e04eab}

\item 
\hypertarget{structoval__entity_a83c1999f4b05fb957ce3887bad050441}{
\hyperlink{group__OVALDEF_gaf069fe2fb2a9ae3abe47cab55b89827e}{oval\_\-datatype\_\-t} {\bfseries datatype}}
\label{structoval__entity_a83c1999f4b05fb957ce3887bad050441}

\item 
\hypertarget{structoval__entity_a79d69f7369912a6910228c6d14e69ae8}{
\hyperlink{group__OVALDEF_ga3f00a63428c2b5db781a9c87ec73acd1}{oval\_\-operation\_\-t} {\bfseries operation}}
\label{structoval__entity_a79d69f7369912a6910228c6d14e69ae8}

\item 
\hypertarget{structoval__entity_a85a836b1077a8a76f3d60b2db9fe0484}{
int {\bfseries mask}}
\label{structoval__entity_a85a836b1077a8a76f3d60b2db9fe0484}

\item 
\hypertarget{structoval__entity_aebb1debc143929a6be78be298b3ca5b8}{
\hyperlink{group__OVALDEF_gaf188be33624f01de2946ce6e58b6bf53}{oval\_\-entity\_\-varref\_\-type\_\-t} {\bfseries varref\_\-type}}
\label{structoval__entity_aebb1debc143929a6be78be298b3ca5b8}

\item 
\hypertarget{structoval__entity_aaf871d127a6787fa2429fceebfc3360a}{
char $\ast$ {\bfseries name}}
\label{structoval__entity_aaf871d127a6787fa2429fceebfc3360a}

\item 
\hypertarget{structoval__entity_a04eb2efff7fe86aa017463062c03925a}{
struct \hyperlink{structoval__variable}{oval\_\-variable} $\ast$ {\bfseries variable}}
\label{structoval__entity_a04eb2efff7fe86aa017463062c03925a}

\item 
\hypertarget{structoval__entity_a809536818f28a8d4e1941d73e4b7da7f}{
struct \hyperlink{structoval__value}{oval\_\-value} $\ast$ {\bfseries value}}
\label{structoval__entity_a809536818f28a8d4e1941d73e4b7da7f}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
OVAL entity. 

The documentation for this struct was generated from the following files:\begin{DoxyCompactItemize}
\item 
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/OVAL/\hyperlink{oval__entity_8c}{oval\_\-entity.c}\item 
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/OVAL/public/\hyperlink{oval__definitions_8h}{oval\_\-definitions.h}\end{DoxyCompactItemize}