WsfMessage

WsfMessage inherits WsfObject

Construction: WsfMessage newObj = WsfMessage();

Clone: WsfMessage newObj = WsfMessage(other);

Methods

string Originator()

Returns the originating platform name.

int SizeInBits()

Returns the message size in bits.

void SetSizeInBits(int aSizeInBits)

Sets the message size in bits.

int SizeInBytes()

Returns the message size in bytes.

void SetSizeInBytes(int aSizeInBytes)

Sets the message size in bytes.

int Priority()

Returns the priority of the message. Higher values indicate higher priority.

void SetPriority(int aPriority)

Sets the priority of the message. Higher values indicate higher priority.

int SerialNumber()

Returns the message’s serial number.

double DataTag()

Returns the data tag associated with the data object(s) in the message. Data tags are normally assigned internally by the software and represent a ‘tag’ or ‘stamp’ that uniquely identifies an object at a particular time. For instance, the producer of tracks and images will assign a data tag when (s)he updates the track or the image.

void CreateDataTag()

Creates a data tag for this message.

void SetDataTag(double aDataTag)

Sets the data tag for this message.

string Type()

Returns the message’s type.

string SubType()

Returns the message’s subtype.

void SetType(string aType)

Sets the message’s type.

void SetSubType(string aSubType)

Sets the message’s subtype.

WsfAddress Destination()

Returns the address indicating this message’s destination.

WsfAddress NextHop()

Returns the address indicating this message’s next hop, if available.

Auxiliary Data Methods

Auxiliary Data is a collection of optional named user data attributes that can be stored with the object. The framework will maintain the attributes but in no other way attempts to use the data contained within. The definition and use of any attribute is defined purely by the user.

bool AuxDataBool(string aName)

int AuxDataInt(string aName)

double AuxDataDouble(string aName)

string AuxDataString(string aName)

Object AuxDataObject(string aName)

Retrieve the value of the auxiliary data attribute with the indicated name. If the attribute does not exist then a default value will be returned (false for bool, 0 for int and 0.0 for double).

bool AuxDataExists(string aName)

bool CheckAuxData(string aName)

Returns true if an auxiliary data member exists with the specified name.

bool HasAuxData()

Returns true if the object has auxiliary data.

bool DeleteAuxData(string aName)

Delete the auxiliary data attribute with the indicated name. Returns true if the attribute exists and was deleted, or false if the attribute did not exist.

void SetAuxData(string aName, bool aValue)

void SetAuxData(string aName, int aValue)

void SetAuxData(string aName, double aValue)

void SetAuxData(string aName, string aValue)

void SetAuxData(string aName, Object aValue)

Set the value of the auxiliary data attribute with the indicated name. The last form of SetAuxData() can store any script object type.

Map<string, string> GetAllAuxDataTypes()

Return the names and types of all auxiliary data attributes in the form of a Map<string,string>. Map keys are valid names of auxiliary data attributes. Map values are type names corresponding to valid auxiliary data attribute names.