Introduction
Documentation Home What is OpenMAMA? Supported Platforms Versioning
Tutorials
1. Quick Start 2. Using MAMA Resource Pool
User Guides
Installing OpenMAMA OpenMAMA Developer's Guide OpenMAMDA Developer's Guide API Reference Docs Portable Demo Environment IDE Integration Running Example Apps Qpid Bridge Raising Issues Performance Testing Vulnerability Reporting
Contributor Guides
Contributing to Documentation Third Party Repository Building From Source Bridge Building Documentation Bridge Developer FAQ Bridge Incorporation Guidelines Coding Standards Dynamic Bridge Loading Long Lived Feature Branches Release Process Submission Process Unit Testing
RFC Documents
Open Closed Process Template
Classes Files

Wombat::MamdaOrderImbalanceSide

Public Functions

  Name
override string ToString()
Returns the string name for the enumerated type.
string toString()
Returns the string name for the enumerated type.
int getValue()
Returns the integer value for the type. This value can be used in switch statements against the public XXX_VALUE const members of the class.
bool equals(MamdaOrderImbalanceSide imbalanceSide)
Compare the two types for equality.
override bool Equals(object obj)
override int GetHashCode()
bool operator==(MamdaOrderImbalanceSide left, MamdaOrderImbalanceSide right)
bool operator!=(MamdaOrderImbalanceSide left, MamdaOrderImbalanceSide right)
String valueToString(int value)
Utility method for mapping type integer values to corresponding string values.
MamdaOrderImbalanceSide enumObjectForValue(int value)
Return an instance of a MamdaOrderImbalanceSide corresponding to the specified integer value. Returns null if the integer value is not recognised.

Public Attributes

  Name
const int BID_SIDE_VALUE
readonly MamdaOrderImbalanceSide BID_SIDE
const int ASK_SIDE_VALUE
readonly MamdaOrderImbalanceSide ASK_SIDE
const int NO_IMBALANCE_VALUE
readonly MamdaOrderImbalanceSide NO_IMBALANCE_SIDE

Public Functions Documentation

function ToString

override string ToString()

Returns the string name for the enumerated type.

Return: Name for the type.

function toString

string toString()

Returns the string name for the enumerated type.

Return: Name for the type.

function getValue

int getValue()

Returns the integer value for the type. This value can be used in switch statements against the public XXX_VALUE const members of the class.

Return: The integer type.

function equals

bool equals(
    MamdaOrderImbalanceSide imbalanceSide
)

Compare the two types for equality.

Parameters:

  • imbalanceSide The object to check equality against.

Return: Returns true if the integer value of both types is equal. Otherwise returns false.

function Equals

override bool Equals(
    object obj
)

function GetHashCode

override int GetHashCode()

function operator==

static bool operator==(
    MamdaOrderImbalanceSide left,
    MamdaOrderImbalanceSide right
)

function operator!=

static bool operator!=(
    MamdaOrderImbalanceSide left,
    MamdaOrderImbalanceSide right
)

function valueToString

static String valueToString(
    int value
)

Utility method for mapping type integer values to corresponding string values.

Parameters:

Return: The string name value of the specified MamdaOrderImbalanceSide integer value

Returns “UNKNOWN” is the int type value is not recognised.

function enumObjectForValue

static MamdaOrderImbalanceSide enumObjectForValue(
    int value
)

Return an instance of a MamdaOrderImbalanceSide corresponding to the specified integer value. Returns null if the integer value is not recognised.

Parameters:

Return: Instance of a MamdaOrderImbalanceSide if a mapping exists.

Public Attributes Documentation

variable BID_SIDE_VALUE

static const int BID_SIDE_VALUE = 0;

BID_SIDE_IMBALANCE

variable BID_SIDE

static readonly MamdaOrderImbalanceSide BID_SIDE =
			new MamdaOrderImbalanceSide(valueToString(BID_SIDE_VALUE), BID_SIDE_VALUE);

variable ASK_SIDE_VALUE

static const int ASK_SIDE_VALUE = 1;

ASK_SIDE_IMBALANCE

variable ASK_SIDE

static readonly MamdaOrderImbalanceSide ASK_SIDE =
			new MamdaOrderImbalanceSide(valueToString(ASK_SIDE_VALUE), ASK_SIDE_VALUE);

variable NO_IMBALANCE_VALUE

static const int NO_IMBALANCE_VALUE = 2;

NO_IMBALANCE

variable NO_IMBALANCE_SIDE

static readonly MamdaOrderImbalanceSide NO_IMBALANCE_SIDE =
			new MamdaOrderImbalanceSide(valueToString(NO_IMBALANCE_VALUE), NO_IMBALANCE_VALUE);

Updated on 2023-03-31 at 15:30:13 +0100