Class ValueHistoryMessage

Specialized value history that stores Message data and compares messages using their custom equality check.

Inheritance
object
ValueHistory<Message>
ValueHistoryMessage
Implements
Namespace: AS2.Sim
Assembly: .dll
Syntax
public class ValueHistoryMessage : ValueHistory<Message>, IReplayHistory

Constructors

| Edit this page View Source

ValueHistoryMessage(Message, int)

Declaration
public ValueHistoryMessage(Message initialValue, int initialRound = 0)
Parameters
Type Name Description
Message initialValue
int initialRound
| Edit this page View Source

ValueHistoryMessage(ValueHistorySaveData<MessageSaveData>)

Same as ValueHistory(ValueHistorySaveData<T>) but specialized for Message history data.

Declaration
public ValueHistoryMessage(ValueHistorySaveData<MessageSaveData> data)
Parameters
Type Name Description
ValueHistorySaveData<MessageSaveData> data

The serializable history data from which to restore the ValueHistoryMessage instance.

Methods

| Edit this page View Source

GenerateMessageSaveData()

Generates value history save data specifically for serialized Message data. Use this instead of GenerateSaveData().

Declaration
public ValueHistorySaveData<MessageSaveData> GenerateMessageSaveData()
Returns
Type Description
ValueHistorySaveData<MessageSaveData>

A serializable object storing history data from which Messages can be restored.
| Edit this page View Source

GenerateSaveData()

Not supported.

Declaration
public override ValueHistorySaveData<Message> GenerateSaveData()
Returns
Type Description
ValueHistorySaveData<Message>

null
Overrides
| Edit this page View Source

ValuesEqual(Message, Message)

Compares two messages using their specific comparison method. null values can be handled.

Declaration
protected override bool ValuesEqual(Message val1, Message val2)
Parameters
Type Name Description
Message val1

The first message to compare.
Message val2

The second message to compare.
Returns
Type Description
bool

true if and only if
Overrides

Implements