- <strong>Normal mode</strong>: use bt_ctf_trace_create() to create a
default, empty trace class.
-- <strong>CTF IR writer mode</strong>: use bt_ctf_writer_get_trace() to
- get the trace class created by a given CTF IR writer object.
+- <strong>CTF writer mode</strong>: use bt_ctf_writer_get_trace() to
+ get the trace class created by a given CTF writer object.
A trace class has the following properties:
- A \b name.
- A <strong>default byte order</strong>: all the
- \link ctfirfieldtype field types\endlink eventually part of the trace
+ \link ctfirfieldtypes field types\endlink eventually part of the trace
class with a byte order set to #BT_CTF_BYTE_ORDER_NATIVE have this
"real" byte order.
- An \b environment, which is a custom key-value mapping. Keys are
- bt_ctf_trace_add_stream_class()
- bt_ctf_writer_create_stream()
- (\link ctfirwriter CTF IR writer\endlink mode only)
+ (\link ctfwriter CTF writer\endlink mode only)
You cannot modify a frozen trace class: it is considered immutable,
except for:
- Adding a stream class to it with
bt_ctf_trace_add_stream_class().
-- Adding a clock class to it with bt_ctf_trace_add_clock().
+- Adding a clock class to it with bt_ctf_trace_add_clock_class().
- \link refs Reference counting\endlink.
You can add a custom listener with bt_ctf_trace_add_listener() to get
struct bt_ctf_trace;
struct bt_ctf_stream;
struct bt_ctf_stream_class;
-struct bt_ctf_clock;
+struct bt_ctf_clock_class;
/**
@name Creation function
@param[in] trace_class Trace class of which to get the packet
header field type.
@returns Packet header field type of \p trace_class,
- or \c NULL on error.
+ or \c NULL if \p trace_class has no packet header field
+ type or on error.
@prenotnull{trace_class}
@postrefcountsame{trace_class}
-@postsuccessrefcountretinc
+@post <strong>On success, if the return value is a field type</strong>, its
+ reference count is incremented.
@sa bt_ctf_trace_set_packet_header_type(): Sets the packet
header field type of a given trace class.
/**
@brief Sets the packet header field type of the CTF IR trace class
- \p trace_class to \p packet_context_type.
+ \p trace_class to \p packet_header_type, or unsets the current packet
+ header field type from \p trace_class.
+
+If \p packet_header_type is \c NULL, then this function unsets the current
+packet header field type from \p trace_class, effectively making \p trace_class
+a trace without a packet header field type.
-As of Babeltrace \btversion, \p packet_context_type \em must be a
-CTF IR structure field type object.
+As of Babeltrace \btversion, if \p packet_header_type is not \c NULL,
+\p packet_header_type \em must be a CTF IR structure field type object.
@param[in] trace_class Trace class of which to set the packet
header field type.
-@param[in] packet_header_type Packet header field type.
+@param[in] packet_header_type Packet header field type, or \c NULL to unset
+ the current packet header field type.
@returns 0 on success, or a negative value on error.
@prenotnull{trace_class}
-@prenotnull{packet_header_type}
@prehot{trace_class}
-@preisstructft{packet_header_type}
+@pre <strong>\p packet_header_type, if not \c NULL</strong>, is a CTF IR
+ structure field type.
@postrefcountsame{trace_class}
-@postsuccessrefcountinc{packet_header_type}
+@post <strong>On success, if \p packet_header_type is not \c NULL</strong>,
+ the reference count of \p packet_header_type is incremented.
@sa bt_ctf_trace_get_packet_header_type(): Returns the packet
header field type of a given trace class.
@prenotnull{trace_class}
@postrefcountsame{trace_class}
*/
-extern int bt_ctf_trace_get_clock_count(struct bt_ctf_trace *trace_class);
+extern int bt_ctf_trace_get_clock_class_count(struct bt_ctf_trace *trace_class);
/**
@brief Returns the clock class at index \p index in the CTF IR trace
@prenotnull{trace_class}
@pre \p index is lesser than the number of clock classes contained in
the trace class \p trace_class (see
- bt_ctf_trace_get_clock_count()).
+ bt_ctf_trace_get_clock_class_count()).
@postrefcountsame{trace_class}
@postsuccessrefcountretinc
-@sa bt_ctf_trace_get_clock_by_name(): Finds a clock class by name.
-@sa bt_ctf_trace_add_clock(): Adds a clock class to a trace class.
+@sa bt_ctf_trace_get_clock_class_by_name(): Finds a clock class by name.
+@sa bt_ctf_trace_add_clock_class(): Adds a clock class to a trace class.
*/
-extern struct bt_ctf_clock *bt_ctf_trace_get_clock(
+extern struct bt_ctf_clock_class *bt_ctf_trace_get_clock_class(
struct bt_ctf_trace *trace_class, int index);
/**
@postrefcountsame{trace_class}
@postsuccessrefcountretinc
-@sa bt_ctf_trace_get_clock(): Returns the clock class contained in a
- given trace class at a given index.
-@sa bt_ctf_trace_add_clock(): Adds a clock class to a trace class.
+@sa bt_ctf_trace_get_clock_class(): Returns the clock class contained
+ in a given trace class at a given index.
+@sa bt_ctf_trace_add_clock_class(): Adds a clock class to a trace class.
*/
-extern struct bt_ctf_clock *bt_ctf_trace_get_clock_by_name(
+extern struct bt_ctf_clock_class *bt_ctf_trace_get_clock_class_by_name(
struct bt_ctf_trace *trace_class, const char *name);
/**
@post <strong>On success, if \p trace_class is frozen</strong>,
\p clock_class is frozen.
-@sa bt_ctf_trace_get_clock(): Returns the clock class contained in a
- given trace class at a given index.
-@sa bt_ctf_trace_get_clock_by_name(): Finds a clock class by name.
+@sa bt_ctf_trace_get_clock_class(): Returns the clock class contained
+ in a given trace class at a given index.
+@sa bt_ctf_trace_get_clock_class_by_name(): Finds a clock class by name.
*/
-extern int bt_ctf_trace_add_clock(struct bt_ctf_trace *trace_class,
- struct bt_ctf_clock *clock_class);
+extern int bt_ctf_trace_add_clock_class(struct bt_ctf_trace *trace_class,
+ struct bt_ctf_clock_class *clock_class);
/** @} */
@postrefcountsame{trace_class}
@postsuccessrefcountretinc
-@sa bt_ctf_trace_get_clock(): Returns the stream class contained in a
- given trace class at a given index.
+@sa bt_ctf_trace_get_stream_class(): Returns the stream class contained
+ in a given trace class at a given index.
@sa bt_ctf_trace_add_stream_class(): Adds a stream class to a trace class.
*/
extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_id(
@postsuccessrefcountinc{stream_class}
@postsuccessfrozen{stream_class}
-@sa bt_ctf_trace_get_clock(): Returns the stream class contained in a
- given trace class at a given index.
+@sa bt_ctf_trace_get_stream_class(): Returns the stream class contained
+ in a given trace class at a given index.
@sa bt_ctf_trace_get_stream_class_by_id(): Finds a stream class by ID.
*/
extern int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace_class,
/** @} */
+/** @} */
+
/*
* bt_ctf_trace_get_metadata_string: get metadata string.
*