File: ofstd.dox

package info (click to toggle)
dcmtk 3.6.9-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 95,648 kB
  • sloc: ansic: 426,874; cpp: 318,177; makefile: 6,401; sh: 4,341; yacc: 1,026; xml: 482; lex: 321; perl: 277
file content (63 lines) | stat: -rw-r--r-- 1,569 bytes parent folder | download | duplicates (5)
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
/*!

\page mod_ofstd ofstd: a library of general purpose classes

This module contains general purpose classes which are not specific to the
DICOM standard. They are used extensively throughout the toolkit.

The main classes are (in alphabetical order):
\li \b OFCommandLine
\li \b OFCondition
\li \b OFFile
\li \b OFList
\li \b OFStack
\li \b OFStandard
\li \b OFString
\li \b OFVector

Here are some further utilities that may be of interest:
\li \b OFCharacterEncoding
\li \b OFConsole
\li \b OFConsoleApplication
\li \b OFDate
\li \b OFDateTime
\li \b OFdirectory_iterator
\li \b OFerror_code
\li \b OFMap
\li \b OFoptional
\li \b OFpath
\li \b OFshared_ptr
\li \b #OFstatic_assert
\li \b OFThread
\li \b OFTime
\li \b OFtuple
\li \b OFunique_ptr
\li \b OFvariant

\section Testing

This module also contains a simple test framework.

New tests can be written with the OF_TEST macro and checks can be implemented
with the OF_CHECK, OF_CHECK_EQUAL and OF_FAIL macros. Each test then has to be
registered with OF_TEST_REGISTER() in a source file calling
OF_TEST_MAIN("name_of_module")

Here is an example which uses all these macros:

\code
OF_TEST(ofstd_Example)
{
    // If possible, use this. In case of errors, the error message
    // will contain both values.
    OF_CHECK_EQUAL(1, 2);
    // The error message here will just say that "1 == 2" failed. If you are
    // comparing variables, the values will be unknown.
    OF_CHECK(1 == 2);
    // This just prints a message of your choice.
    if (1 != 2)
        OF_FAIL("1 does not equal 2");
}
\endcode

*/