Accessors.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/CME/MDH/Domain.h>
#include <OnixS/CME/MDH/String.h>

#include <OnixS/CME/MDH/Fields.h>
#include <OnixS/CME/MDH/MbpBookTraits.h>

#include <OnixS/CME/MDH/FIX/MultiContainer.h>
#include <OnixS/CME/MDH/FIX/Tags.h>

ONIXS_CMEMDHFIX_NAMESPACE_BEGIN

/// Raises exception explaining field value conversion failure.
ONIXS_CMEMDH_EXPORTED
void throwFieldConversionFailure(const Char* field, const Char* target);

/// Extracts security id from the given tag-value container.
///
/// Throws an exception if security identifier is not a number.
inline SecurityId securityId(const MultiContainer& message)
{
    SecurityId securityId = 0;

    if (!value(securityId, message, Tags::SecurityID))
    {
        throwFieldConversionFailure("SecurityID(48)", "number");
    }

    return securityId;
}

/// Retrieves security group field value assuming
/// the given message represents a security definition.
///
/// Returns an empty ref if the field is absent.
inline StrRef securityGroup(const MultiContainer& message)
{
    return valueOrDefault(message, Tags::SecurityGroup);
}

/// Retrieves symbol field value assuming the
/// given message represents a security definition.
///
/// Returns an empty ref if the field is absent.
inline StrRef symbol(const MultiContainer& message)
{
    return valueOrDefault(message, Tags::Symbol);
}

/// Retrieves asset field value assuming the
/// given message represents a security definition.
///
/// Returns an empty ref if the field is absent.
inline StrRef asset(const MultiContainer& message)
{
    return valueOrDefault(message, Tags::Asset);
}

/// Retrieves security update action field value assuming
/// the given container represents a security definition.
ONIXS_CMEMDH_EXPORTED
SecurityUpdateAction::Enum securityUpdateAction(const MultiContainer&);

/// Retrieves depths of direct and implied books assuming
/// the given message represents a security definition.
ONIXS_CMEMDH_EXPORTED
void bookDepths(const MultiContainer&, MbpBookDepth&, MbpBookDepth&);

/// Retrieves match event indicator bits.
///
/// Returns an empty bitset if indicator is absent.
ONIXS_CMEMDH_EXPORTED
MatchEventIndicator matchEventIndicator(const MultiContainer&);

/// Retrieves last update time field value.
ONIXS_CMEMDH_EXPORTED
Timestamp timestamp(const MultiContainer&, Tag);

ONIXS_CMEMDHFIX_NAMESPACE_END