Zen API
 All Classes Files Functions Variables Typedefs Macros Groups Pages
kDat6Serializer.h
Go to the documentation of this file.
1 /**
2  * @file kDat6Serializer.h
3  * @brief Declares the kDat6Serializer class.
4  *
5  * @internal
6  * Copyright (C) 2012-2014 by LMI Technologies Inc.
7  * Licensed under the MIT License.
8  * Redistributed files must retain the above copyright notice.
9  */
10 #ifndef K_API_DAT6_SERIALIZER_H
11 #define K_API_DAT6_SERIALIZER_H
12 
13 #include <kApi/kApiDef.h>
14 
15 kBeginHeader()
16 
17 /**
18  * @class kDat6Serializer
19  * @extends kSerializer
20  * @ingroup kApi-Io
21  * @brief Serializes/deserializes objects to/from kDat6 format.
22  */
23 //typedef kSerializer kDat6Serializer; --forward-declared in kApiDef.x.h
24 
25 /**
26  * Constructs a kDat6Serializer object.
27  *
28  * @public @memberof kDat6Serializer
29  * @param serializer Receives the constructed object.
30  * @param stream Stream for reading or writing.
31  * @param allocator Memory allocator (or kNULL for default).
32  * @return Operation status.
33  */
34 kFx(kStatus) kDat6Serializer_Construct(kDat6Serializer* serializer, kStream stream, kAlloc allocator);
35 
36 kEndHeader()
37 
38 #include <kApi/Io/kDat6Serializer.x.h>
39 
40 #endif
Abstract base class for memory allocator types.
Serializes/deserializes objects to/from kDat6 format.
kStatus kDat6Serializer_Construct(kDat6Serializer *serializer, kStream stream, kAlloc allocator)
Constructs a kDat6Serializer object.
Essential API declarations.
Represents an I/O stream.
Represents an enumeration of error codes.