\hypertarget{OTF__MasterControl_8h}{\section{ompi/contrib/vt/vt/extlib/otf/otflib/\+O\+T\+F\+\_\+\+Master\+Control.h File Reference}
\label{OTF__MasterControl_8h}\index{ompi/contrib/vt/vt/extlib/otf/otflib/\+O\+T\+F\+\_\+\+Master\+Control.\+h@{ompi/contrib/vt/vt/extlib/otf/otflib/\+O\+T\+F\+\_\+\+Master\+Control.\+h}}
}


Provides access to process-\/stream-\/mapping, which are located in .otf files.  


{\ttfamily \#include $<$stdlib.\+h$>$}\\*
{\ttfamily \#include $<$stdio.\+h$>$}\\*
{\ttfamily \#include $<$string.\+h$>$}\\*
{\ttfamily \#include \char`\"{}O\+T\+F\+\_\+inttypes.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}O\+T\+F\+\_\+\+File.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}O\+T\+F\+\_\+\+Filenames.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}O\+T\+F\+\_\+\+W\+Buffer.\+h\char`\"{}}\\*
{\ttfamily \#include \char`\"{}O\+T\+F\+\_\+\+R\+Buffer.\+h\char`\"{}}\\*
\subsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \hyperlink{structstruct__OTF__MapEntry}{struct\+\_\+\+O\+T\+F\+\_\+\+Map\+Entry}
\begin{DoxyCompactList}\small\item\em entry for 1\+:n mapping \end{DoxyCompactList}\item 
struct \hyperlink{structstruct__OTF__Pair}{struct\+\_\+\+O\+T\+F\+\_\+\+Pair}
\begin{DoxyCompactList}\small\item\em entry for 1\+:1 mapping \end{DoxyCompactList}\item 
struct \hyperlink{structstruct__OTF__MasterControl}{struct\+\_\+\+O\+T\+F\+\_\+\+Master\+Control}
\begin{DoxyCompactList}\small\item\em Data structure that collects the information about which stream contains which parts of a multi-\/file trace. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Typedefs}
\begin{DoxyCompactItemize}
\item 
\hypertarget{group__mc_gab61120f09ec01225f3c058cedb227f7d}{typedef struct \hyperlink{structstruct__OTF__MapEntry}{struct\+\_\+\+O\+T\+F\+\_\+\+Map\+Entry} \hyperlink{group__mc_gab61120f09ec01225f3c058cedb227f7d}{O\+T\+F\+\_\+\+Map\+Entry}}\label{group__mc_gab61120f09ec01225f3c058cedb227f7d}

\begin{DoxyCompactList}\small\item\em entry for 1\+:n mapping \end{DoxyCompactList}\item 
\hypertarget{group__mc_gad49f2ee6bf9a14cdb2ee68c3aef49099}{typedef struct \hyperlink{structstruct__OTF__Pair}{struct\+\_\+\+O\+T\+F\+\_\+\+Pair} \hyperlink{group__mc_gad49f2ee6bf9a14cdb2ee68c3aef49099}{O\+T\+F\+\_\+\+Pair}}\label{group__mc_gad49f2ee6bf9a14cdb2ee68c3aef49099}

\begin{DoxyCompactList}\small\item\em entry for 1\+:1 mapping \end{DoxyCompactList}\item 
typedef struct \\*
\hyperlink{structstruct__OTF__MasterControl}{struct\+\_\+\+O\+T\+F\+\_\+\+Master\+Control} \hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control}
\begin{DoxyCompactList}\small\item\em master control object. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$ \hyperlink{group__mc_gaace2ad391220ee473427d4371ed24806}{O\+T\+F\+\_\+\+Master\+Control\+\_\+new} (\hyperlink{group__fm_ga621c18447ec33f803cc270a9494b0685}{O\+T\+F\+\_\+\+File\+Manager} $\ast$manager)
\begin{DoxyCompactList}\small\item\em Creates an empty O\+T\+F\+\_\+\+Master\+Control object. \end{DoxyCompactList}\item 
int \hyperlink{group__mc_ga18ee8bc532af983dc4914365fd633664}{O\+T\+F\+\_\+\+Master\+Control\+\_\+read} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc, const char $\ast$namestub)
\begin{DoxyCompactList}\small\item\em I\+N\+T\+E\+R\+F\+A\+C\+E C\+H\+A\+N\+G\+E\+D! Read a master control file according to namestub, reset the {\itshape existing} O\+T\+F\+\_\+\+Master\+Control structure and fill it according to the file. \end{DoxyCompactList}\item 
void \hyperlink{group__mc_ga0375f6bc94d869110cd8dceaf956b229}{O\+T\+F\+\_\+\+Master\+Control\+\_\+finish} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc)
\begin{DoxyCompactList}\small\item\em Destructor, delete O\+T\+F\+\_\+\+Master\+Control object. \end{DoxyCompactList}\item 
void \hyperlink{group__mc_gaad005e740df740bb0138413b8b6cbf11}{O\+T\+F\+\_\+\+Master\+Control\+\_\+close} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc)
\begin{DoxyCompactList}\small\item\em Deletes a O\+T\+F\+\_\+\+Master\+Control object. \end{DoxyCompactList}\item 
int \hyperlink{group__mc_ga80e5053d3307ecd84734cc0cdba0aa77}{O\+T\+F\+\_\+\+Master\+Control\+\_\+append} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc, uint32\+\_\+t argument, uint32\+\_\+t value)
\begin{DoxyCompactList}\small\item\em Append the mapping argument -\/$>$ value to the master control structure,. \end{DoxyCompactList}\item 
int \hyperlink{group__mc_gadc5a19aeefc7115912dd540bf6d5086f}{O\+T\+F\+\_\+\+Master\+Control\+\_\+append\+List} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc, uint32\+\_\+t argument, uint32\+\_\+t l, uint32\+\_\+t $\ast$values)
\begin{DoxyCompactList}\small\item\em Append the mapping argument -\/$>$ ( list of l values ) to the master control structure. \end{DoxyCompactList}\item 
uint32\+\_\+t \hyperlink{group__mc_ga352efaf922c8d686192f0d450b745082}{O\+T\+F\+\_\+\+Master\+Control\+\_\+map\+Reverse} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc, uint32\+\_\+t value)
\begin{DoxyCompactList}\small\item\em Returns the argument to the given value. \end{DoxyCompactList}\item 
int \hyperlink{group__mc_gad6d9710baa9642ae63156af0110b5ff3}{O\+T\+F\+\_\+\+Master\+Control\+\_\+write} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc, const char $\ast$namestub)
\begin{DoxyCompactList}\small\item\em Writes a master control file with the current contents of the given object. \end{DoxyCompactList}\item 
int \hyperlink{group__mc_ga0728d52b257e041c28587dd485b2f742}{O\+T\+F\+\_\+\+Master\+Control\+\_\+check} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc)
\begin{DoxyCompactList}\small\item\em Checks if the current mapping is consistent in itself. \end{DoxyCompactList}\item 
void \hyperlink{group__mc_gaab8e76cb57d4ddd7742860aece58ce77}{O\+T\+F\+\_\+\+Master\+Control\+\_\+print} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc)
\begin{DoxyCompactList}\small\item\em Prints the mapping to stderr. \end{DoxyCompactList}\item 
\hyperlink{group__mc_gab61120f09ec01225f3c058cedb227f7d}{O\+T\+F\+\_\+\+Map\+Entry} $\ast$ \hyperlink{group__mc_ga1ffabf19f47bf4296d88c3ec390c77c2}{O\+T\+F\+\_\+\+Master\+Control\+\_\+get\+Entry} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc, uint32\+\_\+t argument)
\begin{DoxyCompactList}\small\item\em Returns the entry for the given argument. \end{DoxyCompactList}\item 
\hyperlink{group__mc_gab61120f09ec01225f3c058cedb227f7d}{O\+T\+F\+\_\+\+Map\+Entry} $\ast$ \hyperlink{group__mc_ga32a1994c44ae486c34e8bed7690ff0c4}{O\+T\+F\+\_\+\+Master\+Control\+\_\+get\+Entry\+By\+Index} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc, uint32\+\_\+t index)
\begin{DoxyCompactList}\small\item\em Returns the entry for the given index. \end{DoxyCompactList}\item 
\hyperlink{group__mc_gad49f2ee6bf9a14cdb2ee68c3aef49099}{O\+T\+F\+\_\+\+Pair} $\ast$ \hyperlink{group__mc_ga442b7a0c71c194d56609c702818be7b1}{O\+T\+F\+\_\+\+Master\+Control\+\_\+get\+R\+Entry\+By\+Index} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc, uint32\+\_\+t index)
\begin{DoxyCompactList}\small\item\em Returns a pair of value and argument for the given index. \end{DoxyCompactList}\item 
uint32\+\_\+t \hyperlink{group__mc_ga4ef2d0fd8d1c7077569ecec35c4df576}{O\+T\+F\+\_\+\+Master\+Control\+\_\+get\+Count} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc)
\begin{DoxyCompactList}\small\item\em Returns the number of arguments in the current list. \end{DoxyCompactList}\item 
uint32\+\_\+t \hyperlink{group__mc_ga92a99f346fde468db0ab5c7f23fd7f2a}{O\+T\+F\+\_\+\+Master\+Control\+\_\+getr\+Count} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc)
\begin{DoxyCompactList}\small\item\em Returns the number of arguments in current reverse list. \end{DoxyCompactList}\item 
uint32\+\_\+t \hyperlink{group__mc_gaeb764f950e1712e297c819aa37cac37b}{O\+T\+F\+\_\+\+Master\+Control\+\_\+get\+Value\+Count} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc, uint32\+\_\+t argument)
\begin{DoxyCompactList}\small\item\em Returns the number of values for the given argument. \end{DoxyCompactList}\item 
uint32\+\_\+t $\ast$ \hyperlink{group__mc_ga3a320e60a8e128e0bfbb9f12ef2240cb}{O\+T\+F\+\_\+\+Master\+Control\+\_\+get\+Values} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc, uint32\+\_\+t argument)
\begin{DoxyCompactList}\small\item\em Returns a pointer to the value array for 'argument'. \end{DoxyCompactList}\item 
uint32\+\_\+t \hyperlink{group__mc_gaf3a16f6410370eb709f56f644056b6d5}{O\+T\+F\+\_\+\+Master\+Control\+\_\+get\+New\+Stream\+Id} (\hyperlink{group__mc_ga9e558ee162e965f8555109c23b939aea}{O\+T\+F\+\_\+\+Master\+Control} $\ast$mc)
\begin{DoxyCompactList}\small\item\em Returns a previously unused argument. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Provides access to process-\/stream-\/mapping, which are located in .otf files. 

