File: structoval__syschar__model.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 (145 lines) | stat: -rw-r--r-- 11,169 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
\hypertarget{structoval__syschar__model}{
\section{oval\_\-syschar\_\-model Struct Reference}
\label{structoval__syschar__model}\index{oval\_\-syschar\_\-model@{oval\_\-syschar\_\-model}}
}


OVAL System Characteristics model.  


{\ttfamily \#include $<$oval\_\-system\_\-characteristics.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$ \hyperlink{group__OVALSYS_ga353f4be448b6f3cbf27b5c65ca5cc6de}{oval\_\-syschar\_\-model\_\-new} (struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$definition\_\-model)
\begin{DoxyCompactList}\small\item\em Create new \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model}. \item\end{DoxyCompactList}\item 
int \hyperlink{group__OVALSYS_ga29f30efa8fd3a563dd7d1a69672512c7}{oval\_\-syschar\_\-model\_\-import} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$model, const char $\ast$file)
\begin{DoxyCompactList}\small\item\em Import the content from the file into an \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model}. \item\end{DoxyCompactList}\item 
struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$ \hyperlink{group__OVALSYS_ga70e8603c48f80bb70882307dad653b96}{oval\_\-syschar\_\-model\_\-clone} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$)
\begin{DoxyCompactList}\small\item\em Copy an \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model}. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALSYS_ga479b0cd10549cac962c4705c53a01c1a}{
int \hyperlink{group__OVALSYS_ga479b0cd10549cac962c4705c53a01c1a}{oval\_\-syschar\_\-model\_\-export} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$, const char $\ast$file)}
\label{group__OVALSYS_ga479b0cd10549cac962c4705c53a01c1a}

\begin{DoxyCompactList}\small\item\em Export system characteristics into file. \item\end{DoxyCompactList}\item 
void \hyperlink{group__OVALSYS_ga527dff22377e96580378737cade55f2d}{oval\_\-syschar\_\-model\_\-free} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$model)
\begin{DoxyCompactList}\small\item\em Free memory allocated to a specified syschar model. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf Setters}\par
{\em \label{_amgrp6e47466b75bb957a603aa54c079ac8bf}
 }\begin{DoxyCompactItemize}
\item 
\hypertarget{group__OVALSYS_gab35fe51a10f0ce78ae42e01c08419147}{
void \hyperlink{group__OVALSYS_gab35fe51a10f0ce78ae42e01c08419147}{oval\_\-syschar\_\-model\_\-bind\_\-variable\_\-model} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$, struct \hyperlink{structoval__variable__model}{oval\_\-variable\_\-model} $\ast$)}
\label{group__OVALSYS_gab35fe51a10f0ce78ae42e01c08419147}

\begin{DoxyCompactList}\small\item\em Bind a variable model to the definitions bound to the syschar model. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALSYS_gad201448d20a17d96f95e7f1e5b139f60}{
void {\bfseries oval\_\-syschar\_\-model\_\-add\_\-syschar} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$model, struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$syschar)}
\label{group__OVALSYS_gad201448d20a17d96f95e7f1e5b139f60}

\item 
\hypertarget{group__OVALSYS_gac4d6cf2b9650871482749fa3f9598dd9}{
void {\bfseries oval\_\-syschar\_\-model\_\-add\_\-sysdata} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$model, struct \hyperlink{structoval__sysdata}{oval\_\-sysdata} $\ast$sysdata)}
\label{group__OVALSYS_gac4d6cf2b9650871482749fa3f9598dd9}

\item 
\hypertarget{group__OVALSYS_gaa6f5115ed1f50b41cf26daaaf38aede8}{
void {\bfseries oval\_\-syschar\_\-model\_\-set\_\-sysinfo} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$model, struct \hyperlink{structoval__sysinfo}{oval\_\-sysinfo} $\ast$sysinfo)}
\label{group__OVALSYS_gaa6f5115ed1f50b41cf26daaaf38aede8}

\item 
\hypertarget{group__OVALSYS_gaac3c44398f568f7df5a59df12cd9a8b2}{
void {\bfseries oval\_\-syschar\_\-model\_\-add\_\-variable\_\-binding} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$model, struct \hyperlink{structoval__variable__binding}{oval\_\-variable\_\-binding} $\ast$binding)}
\label{group__OVALSYS_gaac3c44398f568f7df5a59df12cd9a8b2}

\item 
void \hyperlink{group__OVALSYS_gac791056206dbc9e3aba7499f34d6bbe9}{oval\_\-syschar\_\-model\_\-lock} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$syschar\_\-model)
\begin{DoxyCompactList}\small\item\em Lock the syschar\_\-model instance. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Getters}\par
{\em \label{_amgrpc9fd0bcb5385a65354c37f1bb504399d}
 }\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$ \hyperlink{group__OVALSYS_gad4e361e0896ee66bd8f667f81dbd4c40}{oval\_\-syschar\_\-model\_\-get\_\-definition\_\-model} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$model)
\begin{DoxyCompactList}\small\item\em Return related \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} from an \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model}. \item\end{DoxyCompactList}\item 
struct \hyperlink{structoval__syschar__iterator}{oval\_\-syschar\_\-iterator} $\ast$ \hyperlink{group__OVALSYS_ga9ef646299c855dec8e4483d4d0a90593}{oval\_\-syschar\_\-model\_\-get\_\-syschars} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$model)
\begin{DoxyCompactList}\small\item\em Return an iterator over the oval\_\-sychar objects persisted by this model. \item\end{DoxyCompactList}\item 
struct \hyperlink{structoval__sysinfo}{oval\_\-sysinfo} $\ast$ \hyperlink{group__OVALSYS_ga1c61183b3e87b54f48234e5cf1bad866}{oval\_\-syschar\_\-model\_\-get\_\-sysinfo} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$model)
\begin{DoxyCompactList}\small\item\em Return default sysinfo bound to syschar model. \item\end{DoxyCompactList}\item 
struct \hyperlink{structoval__syschar}{oval\_\-syschar} $\ast$ \hyperlink{group__OVALSYS_gab944809c782bb6c33f3e0a3fa0e8ec88}{oval\_\-syschar\_\-model\_\-get\_\-syschar} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$model, const char $\ast$object\_\-id)
\begin{DoxyCompactList}\small\item\em Return the \hyperlink{structoval__syschar}{oval\_\-syschar} bound to a specified object\_\-id. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALSYS_ga2c35e485e508643f4ba51a594f92bce2}{
int \hyperlink{group__OVALSYS_ga2c35e485e508643f4ba51a594f92bce2}{oval\_\-syschar\_\-model\_\-compute\_\-variable} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$, struct \hyperlink{structoval__variable}{oval\_\-variable} $\ast$)}
\label{group__OVALSYS_ga2c35e485e508643f4ba51a594f92bce2}

\begin{DoxyCompactList}\small\item\em Get the oval\_\-values bound to a specified variable. \item\end{DoxyCompactList}\item 
\hypertarget{group__OVALSYS_ga6ee2215ec8c150a20b36488002fb281c}{
struct \hyperlink{structoval__sysdata}{oval\_\-sysdata} $\ast$ {\bfseries oval\_\-syschar\_\-model\_\-get\_\-sysdata} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$, const char $\ast$)}
\label{group__OVALSYS_ga6ee2215ec8c150a20b36488002fb281c}

\item 
bool \hyperlink{group__OVALSYS_gaced89fb486e89ccfbb2a10fdb3da684d}{oval\_\-syschar\_\-model\_\-is\_\-locked} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$syschar\_\-model)
\begin{DoxyCompactList}\small\item\em Return {\bfseries true} if the syschar\_\-model instance is locked. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Evaluators}\par
{\em \label{_amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2}
 }\begin{DoxyCompactItemize}
\item 
\hypertarget{group__OVALSYS_gaba8b7e033751e295a9daca9ae13180b8}{
bool \hyperlink{group__OVALSYS_gaba8b7e033751e295a9daca9ae13180b8}{oval\_\-syschar\_\-model\_\-is\_\-valid} (struct \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} $\ast$syschar\_\-model)}
\label{group__OVALSYS_gaba8b7e033751e295a9daca9ae13180b8}

\begin{DoxyCompactList}\small\item\em Return {\bfseries true} if the syschar\_\-model instance is valid An \hyperlink{structoval__syschar__model}{oval\_\-syschar\_\-model} is valid if all the following are true
\begin{DoxyItemize}
\item The sysinfo attribute is valid
\item The associated \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} is valid
\item All included syschars are valid
\item All included variable\_\-bindings are valid. 
\end{DoxyItemize}\item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item 
\hypertarget{structoval__syschar__model_a03e8e832be88361db02dadb1a794703d}{
struct \hyperlink{structoval__sysinfo}{oval\_\-sysinfo} $\ast$ {\bfseries sysinfo}}
\label{structoval__syschar__model_a03e8e832be88361db02dadb1a794703d}

\item 
\hypertarget{structoval__syschar__model_a398f1bd26637fb4e0870b52076baf3b4}{
struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$ {\bfseries definition\_\-model}}
\label{structoval__syschar__model_a398f1bd26637fb4e0870b52076baf3b4}

\item 
\hypertarget{structoval__syschar__model_a594b89b672a528a795a61aa91b546353}{
struct \hyperlink{structoval__string__map}{oval\_\-string\_\-map} $\ast$ {\bfseries syschar\_\-map}}
\label{structoval__syschar__model_a594b89b672a528a795a61aa91b546353}

\item 
\hypertarget{structoval__syschar__model_a62e6835f1f15e91f6e78cbb3c2332302}{
struct \hyperlink{structoval__string__map}{oval\_\-string\_\-map} $\ast$ {\bfseries sysdata\_\-map}}
\label{structoval__syschar__model_a62e6835f1f15e91f6e78cbb3c2332302}

\item 
\hypertarget{structoval__syschar__model_acec8c42894c1a7a7def3294505260da8}{
struct \hyperlink{structoval__string__map}{oval\_\-string\_\-map} $\ast$ {\bfseries variable\_\-binding\_\-map}}
\label{structoval__syschar__model_acec8c42894c1a7a7def3294505260da8}

\item 
\hypertarget{structoval__syschar__model_acaf23312c2bbc843368a960271ffe42a}{
bool {\bfseries is\_\-locked}}
\label{structoval__syschar__model_acaf23312c2bbc843368a960271ffe42a}

\item 
\hypertarget{structoval__syschar__model_a6597927efa2525a164cc9e2261c2fb68}{
char $\ast$ {\bfseries schema}}
\label{structoval__syschar__model_a6597927efa2525a164cc9e2261c2fb68}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
OVAL System Characteristics model. Object model holds OVAL system characteristics structure instances. 

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__agent_8c}{oval\_\-agent.c}\item 
/home/pvrabec/project/openscap/openscap-\/0.5.12/src/OVAL/public/\hyperlink{oval__system__characteristics_8h}{oval\_\-system\_\-characteristics.h}\end{DoxyCompactItemize}