balxml_encodingstyle.h

Go to the documentation of this file.

/// @file balxml_encodingstyle.h
///
/// The content of this file has been pre-processed for Doxygen.
///
 
 
// balxml_encodingstyle.h          *DO NOT EDIT*           @generated -*-C++-*-
#ifndef INCLUDED_BALXML_ENCODINGSTYLE
#define INCLUDED_BALXML_ENCODINGSTYLE
 
#include <bsls_ident.h>
BSLS_IDENT_RCSID(balxml_encodingstyle_h,"$Id$ $CSID$")
BSLS_IDENT_PRAGMA_ONCE
 
/// @defgroup balxml_encodingstyle balxml_encodingstyle
/// @brief  Provide value-semantic attribute classes
/// @addtogroup bal
/// @{
/// @addtogroup balxml
/// @{
/// @addtogroup balxml_encodingstyle
/// @{
///
/// <h1> Outline </h1>
/// * <a href="#balxml_encodingstyle-purpose"> Purpose</a>
///
/// # Purpose {#balxml_encodingstyle-purpose}
/// Provide value-semantic attribute classes
/// @}
/** @} */
/** @} */
 
/** @addtogroup bal
 * @{
 */
/** @addtogroup balxml
 * @{
 */
/** @addtogroup balxml_encodingstyle
 * @{
 */
 
#include <bslalg_typetraits.h>
 
#include <bdlat_attributeinfo.h>
 
#include <bdlat_enumeratorinfo.h>
 
#include <bdlat_typetraits.h>
 
#include <bsls_assert.h>
 
#include <bsl_iosfwd.h>
#include <bsl_limits.h>
 
#include <bsl_ostream.h>
#include <bsl_string.h>
 
 
 
namespace balxml {
 
                            // ===================
                            // class EncodingStyle
                            // ===================
 
/// Enumeration of encoding style (COMPACT or PRETTY).
/// This struct is generated using bas_codegen.pl called by
/// balxml/code_from_xsd.pl
///
/// See @ref balxml_encodingstyle 
struct EncodingStyle {
 
  public:
    // TYPES
    enum Value {
        COMPACT        = 0
      , PRETTY         = 1
#ifndef BDE_OMIT_INTERNAL_DEPRECATED
      , e_COMPACT      = COMPACT
      , e_PRETTY       = PRETTY
      , BAEXML_COMPACT = COMPACT
      , BAEXML_PRETTY  = PRETTY
#endif
    };
 
    enum {
        NUM_ENUMERATORS = 2
    };
 
    // CONSTANTS
    static const char CLASS_NAME[];
 
    static const bdlat_EnumeratorInfo ENUMERATOR_INFO_ARRAY[];
 
    // CLASS METHODS
 
    /// Return the string representation exactly matching the enumerator
    /// name corresponding to the specified enumeration `value`.
    static const char *toString(Value value);
 
    /// Load into the specified `result` the enumerator matching the
    /// specified `string` of the specified `stringLength`.  Return 0 on
    /// success, and a non-zero value with no effect on `result` otherwise
    /// (i.e., `string` does not match any enumerator).
    static int fromString(Value        *result,
                          const char   *string,
                          int           stringLength);
 
    /// Load into the specified `result` the enumerator matching the
    /// specified `string`.  Return 0 on success, and a non-zero value with
    /// no effect on `result` otherwise (i.e., `string` does not match any
    /// enumerator).
    static int fromString(Value                   *result,
                          const bsl::string_view&  string);
 
    /// Load into the specified `result` the enumerator matching the
    /// specified `number`.  Return 0 on success, and a non-zero value with
    /// no effect on `result` otherwise (i.e., `number` does not match any
    /// enumerator).
    static int fromInt(Value *result, int number);
 
    /// Write to the specified `stream` the string representation of
    /// the specified enumeration `value`.  Return a reference to
    /// the modifiable `stream`.
    static bsl::ostream& print(bsl::ostream& stream, Value value);
};
 
// FREE OPERATORS
 
/// Format the specified `rhs` to the specified output `stream` and
/// return a reference to the modifiable `stream`.
inline
bsl::ostream& operator<<(bsl::ostream& stream, EncodingStyle::Value rhs);
 
}  // close package namespace
 
// TRAITS
 
BDLAT_DECL_ENUMERATION_TRAITS(balxml::EncodingStyle)
 
 
// ============================================================================
//                         INLINE FUNCTION DEFINITIONS
// ============================================================================
 
namespace balxml {
 
                            // -------------------
                            // class EncodingStyle
                            // -------------------
 
// CLASS METHODS
inline
int EncodingStyle::fromString(Value *result, const bsl::string_view& string)
{
    return fromString(result,
                      string.data(),
                      static_cast<int>(string.length()));
}
 
inline
bsl::ostream& EncodingStyle::print(bsl::ostream&      stream,
                                 EncodingStyle::Value value)
{
    return stream << toString(value);
}
 
}  // close package namespace
 
// FREE FUNCTIONS
 
inline
bsl::ostream& balxml::operator<<(
        bsl::ostream& stream,
        balxml::EncodingStyle::Value rhs)
{
    return balxml::EncodingStyle::print(stream, rhs);
}
 
 
#endif
 
// BAS_CODEGEN RUN BY code_from_xsd.pl RUN ON Thu Sep 24 20:40:02 EDT 2020
// GENERATED BY BLP_BAS_CODEGEN_2020.09.14
// USING bas_codegen.pl -m msg -p balxml -E --noExternalization --noAggregateConversion --noHashSupport balxml.xsd
 
// ----------------------------------------------------------------------------
// Copyright 2020 Bloomberg Finance L.P.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------- END-OF-FILE ----------------------------------
 
/** @} */
/** @} */
/** @} */