This class provides a container for the context of a transmitted log record.
Synopsis
Declared in <ball_context.h>
class Context;
Description
This class provides a container for aggregating the auxiliary information needed to transmit a log record. For each context attribute in this class (e.g., recordIndex), there is an accessor for obtaining the attribute's value (recordIndex) and there are manipulators for changing the contained attribute values (setAttributes checks attribute constraints; setAttributesRaw and setRecordIndexRaw do not). A static isValid method is also provided to verify that particular attribute values are consistent before they are used to create or modify a context object. Note that it is the client's responsibility not to construct or unilaterally modify a context object to hold incompatible attribute values.
Additionally, this class supports a complete set of value semantic operations, including copy construction, assignment and equality comparison, and ostream printing. A precise operational definition of when two instances have the same value can be found in the description of operator== for the class. This class is exception neutral with no guarantee of rollback: if an exception is thrown during the invocation of a method on a pre‐existing instance, the object is left in a valid state, but its value is undefined. In no event is memory leaked. Finally, aliasing (e.g., using all or part of an object as both source and destination) is supported in all cases.
Member Functions
Name |
Description |
|
Constructors |
Assign to this context object the value of the specified |
|
Format this object to the specified output |
|
Return the record index attribute of this context object. |
|
Return the sequence length attribute of this context object. |
|
Set the attributes of this context object if they represent a valid context. |
|
Set the attributes of this context object without validating them. |
|
Set the record index attribute of this context object to the specified |
|
Return the transmission cause attribute of this context object. |
|
|
Declare that this type uses a |
Static Member Functions
Name |
Description |
Return whether the given attributes represent a valid context. |
Friends
Name |
Description |
Return |
Non-Member Functions
Name |
Description |
Return |
Created with MrDocs