\hypertarget{structoval__definition}{
\section{oval\_\-definition Struct Reference}
\label{structoval__definition}\index{oval\_\-definition@{oval\_\-definition}}
}
Oval definition specification.
{\ttfamily \#include $<$oval\_\-definitions.h$>$}\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$ \hyperlink{group__OVALDEF_ga88ad8ff9eef847730a6b9eefcbc64b1b}{oval\_\-definition\_\-new} (struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$, char $\ast$id)
\begin{DoxyCompactList}\small\item\em Construct an instance of \hyperlink{structoval__definition}{oval\_\-definition}. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_gab2368745a29f1e3a4649f513231fee10}{oval\_\-definition\_\-free} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$)
\begin{DoxyCompactList}\small\item\em Release an instance of \hyperlink{structoval__definition}{oval\_\-definition}. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\begin{Indent}{\bf Getters}\par
{\em \label{_amgrpc9fd0bcb5385a65354c37f1bb504399d}
}\begin{DoxyCompactItemize}
\item
const char $\ast$ \hyperlink{group__OVALDEF_ga80e2cee5cca6dee041a3ef6f289a320b}{oval\_\-definition\_\-model\_\-supported} (void)
\begin{DoxyCompactList}\small\item\em Get supported version of OVAL XML. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_ga99081e73c5061713ad525ad5655a8256}{
char $\ast$ \hyperlink{group__OVALDEF_ga99081e73c5061713ad525ad5655a8256}{oval\_\-definition\_\-get\_\-id} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$)}
\label{group__OVALDEF_ga99081e73c5061713ad525ad5655a8256}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$id (identifier). \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_ga311335f5126c9713b5f862b64dc0431c}{
int \hyperlink{group__OVALDEF_ga311335f5126c9713b5f862b64dc0431c}{oval\_\-definition\_\-get\_\-version} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$)}
\label{group__OVALDEF_ga311335f5126c9713b5f862b64dc0431c}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$version. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_ga673e679af81822caefa51b35904fd4b5}{
\hyperlink{group__OVALDEF_ga3323efc68980168d0187c26dd22bfce1}{oval\_\-definition\_\-class\_\-t} \hyperlink{group__OVALDEF_ga673e679af81822caefa51b35904fd4b5}{oval\_\-definition\_\-get\_\-class} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$)}
\label{group__OVALDEF_ga673e679af81822caefa51b35904fd4b5}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$class. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_gad9ccbdb5e7d16da6f8ab0309a91359c8}{
bool \hyperlink{group__OVALDEF_gad9ccbdb5e7d16da6f8ab0309a91359c8}{oval\_\-definition\_\-get\_\-deprecated} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$)}
\label{group__OVALDEF_gad9ccbdb5e7d16da6f8ab0309a91359c8}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$deprecated. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_gaf256261a2bdf5097472a61696d528013}{
char $\ast$ \hyperlink{group__OVALDEF_gaf256261a2bdf5097472a61696d528013}{oval\_\-definition\_\-get\_\-title} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$)}
\label{group__OVALDEF_gaf256261a2bdf5097472a61696d528013}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$title. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_ga5ee99958ccc7504e32fd6d41362c331b}{
char $\ast$ \hyperlink{group__OVALDEF_ga5ee99958ccc7504e32fd6d41362c331b}{oval\_\-definition\_\-get\_\-description} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$)}
\label{group__OVALDEF_ga5ee99958ccc7504e32fd6d41362c331b}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$description. \item\end{DoxyCompactList}\item
struct \hyperlink{structoval__affected__iterator}{oval\_\-affected\_\-iterator} $\ast$ \hyperlink{group__OVALDEF_ga23b53971a6953e8f6e92385ea297bb5d}{oval\_\-definition\_\-get\_\-affected} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$affected. \item\end{DoxyCompactList}\item
struct \hyperlink{structoval__reference__iterator}{oval\_\-reference\_\-iterator} $\ast$ \hyperlink{group__OVALDEF_ga31a2cc76f167f1b436ab7f4d0b6a7b78}{oval\_\-definition\_\-get\_\-references} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$references. \item\end{DoxyCompactList}\item
struct \hyperlink{structoval__string__iterator}{oval\_\-string\_\-iterator} $\ast$ \hyperlink{group__OVALDEF_gaa6d0f0af7d4f71c5c917a9d18debe997}{oval\_\-definition\_\-get\_\-notes} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$)
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$notes. \item\end{DoxyCompactList}\item
\hypertarget{group__OVALDEF_gaa771c9866e018d4445433c07a107abf4}{
struct \hyperlink{structoval__criteria__node}{oval\_\-criteria\_\-node} $\ast$ \hyperlink{group__OVALDEF_gaa771c9866e018d4445433c07a107abf4}{oval\_\-definition\_\-get\_\-criteria} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$)}
\label{group__OVALDEF_gaa771c9866e018d4445433c07a107abf4}
\begin{DoxyCompactList}\small\item\em Returns attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$criteria. \item\end{DoxyCompactList}\item
bool \hyperlink{group__OVALDEF_gaee8336be5e6eb9ca54533323b6877f89}{oval\_\-definition\_\-is\_\-locked} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$definition)
\begin{DoxyCompactList}\small\item\em return {\bfseries true} if the definition instance is locked. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Setters}\par
{\em \label{_amgrp6e47466b75bb957a603aa54c079ac8bf}
}\begin{DoxyCompactItemize}
\item
void \hyperlink{group__OVALDEF_gab2aee7edf52662652eb0fb9ddd8bef5e}{oval\_\-definition\_\-set\_\-version} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$, int version)
\begin{DoxyCompactList}\small\item\em Set attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$version. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_gab423431db12f7cba0953230648315c20}{oval\_\-definition\_\-set\_\-class} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$, \hyperlink{group__OVALDEF_ga3323efc68980168d0187c26dd22bfce1}{oval\_\-definition\_\-class\_\-t})
\begin{DoxyCompactList}\small\item\em Set attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$class. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_gaa71ba1da6dc02c718878188a899014f3}{oval\_\-definition\_\-set\_\-deprecated} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$, bool deprecated)
\begin{DoxyCompactList}\small\item\em Set attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$deprecated. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_ga6bf26fcb4a1a73cfc4cec902301298fe}{oval\_\-definition\_\-set\_\-title} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$, char $\ast$title)
\begin{DoxyCompactList}\small\item\em Set attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$title. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_ga2069e1282f02ebfb5a661eab90a229d6}{oval\_\-definition\_\-set\_\-description} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$, char $\ast$description)
\begin{DoxyCompactList}\small\item\em Set attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$description. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_gac818befd3b159dfa5723e8d21054ab26}{oval\_\-definition\_\-add\_\-affected} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$, struct \hyperlink{structoval__affected}{oval\_\-affected} $\ast$affected)
\begin{DoxyCompactList}\small\item\em Append instance of \hyperlink{structoval__affected}{oval\_\-affected} to attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$affected. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_ga5cc090c0f8d4c801a59ba6bb1af17e0a}{oval\_\-definition\_\-add\_\-reference} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$, struct \hyperlink{structoval__reference}{oval\_\-reference} $\ast$reference)
\begin{DoxyCompactList}\small\item\em Append instance of \hyperlink{structoval__reference}{oval\_\-reference} to attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$references. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_ga5edd2eb22f538f9dbe77e7b19c760a1d}{oval\_\-definition\_\-add\_\-note} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$, char $\ast$note)
\begin{DoxyCompactList}\small\item\em Append a copy of the note parameter to attribute Oval\_\-definition-\/$>$notes. \item\end{DoxyCompactList}\item
void \hyperlink{group__OVALDEF_ga44fb9c1aefb424c2b3e9c37e542ceff9}{oval\_\-definition\_\-set\_\-criteria} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$, struct \hyperlink{structoval__criteria__node}{oval\_\-criteria\_\-node} $\ast$criteria)
\begin{DoxyCompactList}\small\item\em Set attribute \hyperlink{structoval__definition}{oval\_\-definition}-\/$>$criteria. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\begin{Indent}{\bf Evaluators}\par
{\em \label{_amgrp1fdbbbb8aba6580be2c9cb4b12e86ca2}
}\begin{DoxyCompactItemize}
\item
bool \hyperlink{group__OVALDEF_gaf6a1e29b0fb5656319717d6b5908fefc}{oval\_\-definition\_\-is\_\-valid} (struct \hyperlink{structoval__definition}{oval\_\-definition} $\ast$definition)
\begin{DoxyCompactList}\small\item\em Returns {\bfseries true} if the \hyperlink{structoval__definition}{oval\_\-definition} is valid. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\end{Indent}
\subsection*{Data Fields}
\begin{DoxyCompactItemize}
\item
\hypertarget{structoval__definition_a3b772e665eee717ef9881c64a6cbba34}{
struct \hyperlink{structoval__definition__model}{oval\_\-definition\_\-model} $\ast$ {\bfseries model}}
\label{structoval__definition_a3b772e665eee717ef9881c64a6cbba34}
\item
\hypertarget{structoval__definition_ae50f24a603cf55d51cf4d413f0f66efc}{
char $\ast$ {\bfseries id}}
\label{structoval__definition_ae50f24a603cf55d51cf4d413f0f66efc}
\item
\hypertarget{structoval__definition_a0bb165f7c4ad961a37ba160a96343bca}{
int {\bfseries version}}
\label{structoval__definition_a0bb165f7c4ad961a37ba160a96343bca}
\item
\hypertarget{structoval__definition_a0a3199d8dc417b404345ea5a5d347f04}{
\hyperlink{group__OVALDEF_ga3323efc68980168d0187c26dd22bfce1}{oval\_\-definition\_\-class\_\-t} {\bfseries class}}
\label{structoval__definition_a0a3199d8dc417b404345ea5a5d347f04}
\item
\hypertarget{structoval__definition_a3aae0c82da9d077ac899a0258da11095}{
int {\bfseries deprecated}}
\label{structoval__definition_a3aae0c82da9d077ac899a0258da11095}
\item
\hypertarget{structoval__definition_a6396b5a17e8a0304327ecd8c1b63356c}{
char $\ast$ {\bfseries title}}
\label{structoval__definition_a6396b5a17e8a0304327ecd8c1b63356c}
\item
\hypertarget{structoval__definition_ae72148235debd828d81a12fbfb4ec56d}{
char $\ast$ {\bfseries description}}
\label{structoval__definition_ae72148235debd828d81a12fbfb4ec56d}
\item
\hypertarget{structoval__definition_a3c26dbfdd661d92edd6989c47cb179fe}{
struct \hyperlink{structoval__collection}{oval\_\-collection} $\ast$ {\bfseries affected}}
\label{structoval__definition_a3c26dbfdd661d92edd6989c47cb179fe}
\item
\hypertarget{structoval__definition_aadae17880aad5565db3ad239a538c1d2}{
struct \hyperlink{structoval__collection}{oval\_\-collection} $\ast$ {\bfseries reference}}
\label{structoval__definition_aadae17880aad5565db3ad239a538c1d2}
\item
\hypertarget{structoval__definition_a46681bf3f592b8f7de554b5a5e10caeb}{
struct \hyperlink{structoval__collection}{oval\_\-collection} $\ast$ {\bfseries notes}}
\label{structoval__definition_a46681bf3f592b8f7de554b5a5e10caeb}
\item
\hypertarget{structoval__definition_a535bfdbde1c44d4d06698809240197ca}{
struct \hyperlink{structoval__criteria__node}{oval\_\-criteria\_\-node} $\ast$ {\bfseries criteria}}
\label{structoval__definition_a535bfdbde1c44d4d06698809240197ca}
\end{DoxyCompactItemize}
\subsection{Detailed Description}
Oval definition specification. A definition is the key structure in OVAL. It is analogous to the logical sentence or proposition: if a computer's state matches the configuration parameters laid out in the criteria, then that computer exhibits the state described.
The documentation for this struct was generated from the following files:\begin{DoxyCompactItemize}
\item
/home/pvrabec/openscap/openscap-\/0.5.7/src/OVAL/\hyperlink{oval__definition_8c}{oval\_\-definition.c}\item
/home/pvrabec/openscap/openscap-\/0.5.7/src/OVAL/public/\hyperlink{oval__definitions_8h}{oval\_\-definitions.h}\end{DoxyCompactItemize}
