FieldValue.h

Go to the documentation of this file.

/*
 * Copyright Onix Solutions Limited [OnixS]. All rights reserved.
 *
 * This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
 * and international copyright treaties.
 *
 * Access to and use of the software is governed by the terms of the applicable ONIXS Software
 * Services Agreement (the Agreement) and Customer end user license agreements granting
 * a non-assignable, non-transferable and non-exclusive license to use the software
 * for it's own data processing purposes under the terms defined in the Agreement.
 *
 * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any
 * part of this source code or associated reference material to any other location for further
 * reproduction or redistribution, and any amendments to this copyright notice, are expressly
 * prohibited.
 *
 * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
 * the terms of the Agreement is a violation of copyright law.
 */

#pragma once

#include <OnixS/SURF/MarketData/Decimal.h>
#include <OnixS/SURF/MarketData/Export.h>

#include <iosfwd>
#include <string>

namespace OnixS { namespace SURF { namespace MarketData {

/// Date.
struct ONIXS_TP_SURF_EXPORT Date
{
    /// Initialize default instance.
    Date();

    /// Initializes a new instance to the specified year, month, and day.
    /// \param day The day (1 through the number of days in month).
    /// \param month The month (1 through 12).
    /// \param year The year (1 through 9999).
    /// \throw ArgumentRangeException If year is less than 1 or greater
    /// than 9999 - or - month is less than 1 or greater than 12 - or -
    /// day is less than 1 or greater than the number of days in month.
    Date(int year, int month, int day);

    /// The year component of the date represented by this instance.
    int year;

    /// The month component of the date represented by this instance.
    int month;

    /// The day of the month represented by this instance.
    int day;

    /// Returns string representation.
    std::string toString() const;
};

ONIXS_TP_SURF_EXPORT std::ostream& operator<<(std::ostream&, const Date&);

/// Time.
struct ONIXS_TP_SURF_EXPORT Time
{
    /// Initialize default instance.
    Time();

    /// Initializes a new instance to the specified year, month, and day.
    /// \param hour The hours (0 through 23).
    /// \param minute The minutes (0 through 59).
    /// \throw ArgumentRangeException If hour is less than 0 or greater than 23 - or - minute is
    /// less than 0 or greater than 59.
    Time(int hour, int minute);

    /// The hour component of the date represented by this instance.
    int hour;

    /// The minute component of the date represented by this instance.
    int minute;

    /// Returns string representation.
    std::string toString() const;
};

ONIXS_TP_SURF_EXPORT std::ostream& operator<<(std::ostream&, const Time&);

/// Field value.
struct ONIXS_TP_SURF_EXPORT FieldValue
{
    /// Indicates whether array of zero length.
    bool empty() const;

    /// Returns the field value as a string.
    std::string toString() const;

    /// Returns field value as an int value.
    ///
    /// \throw std::exception if conversion is impossible.
    int toInt32() const;

    /// Returns field value as an 'unsigned int' value.
    ///
    /// \throw std::exception if conversion is impossible.
    unsigned int toUInt32() const;

    /// Returns field value as an 'long long' value.
    ///
    /// \throw std::exception if conversion is impossible.
    long long toInt64() const;

    /// Returns field value as an 'unsigned long long' value.
    ///
    /// \throw std::exception if conversion is impossible.
    unsigned long long toUInt64() const;

    /// Returns the field value as a floating-point number.
    ///
    /// \throw std::exception if conversion is impossible.
    double toDouble() const;

    /// Returns the field value as a decimal number.
    ///
    /// \throw std::exception if conversion is impossible.
    Decimal toDecimal() const;

    /// Returns the field value as Date.
    ///
    /// \throw std::exception if conversion is impossible.
    Date toDate() const;

    /// Returns the field value as Time.
    ///
    /// \throw std::exception if conversion is impossible.
    Time toTime() const;

protected:
    FieldValue(const char* data, size_t length);
    FieldValue(const FieldValue& value);
    FieldValue& operator=(const FieldValue& value);

private:
    const char* data_;
    size_t length_;
};

ONIXS_TP_SURF_EXPORT std::ostream& operator<<(std::ostream&, const FieldValue&);

}}} // namespace OnixS::SURF::MarketData