Description | Example | Return Message | Group

KeyValueMetaData

Save properties to STK objects for search in STK Data Federate (SDF).

Syntax

KeyValueMetaData <ScenarioPath> {Option} [<Parameters>]

Related Commands

Description

The KeyValueMetaData connect command provides the ability to add properties to STK objects which can then be searched in the STK Data Federate (SDF).

The following table describes the Options and <Parameters>.

Option <Parameters> Description
AddPair Key "<Name>" Value "<Value>" Enter the new Key name and value. Spaces are not allowed in the key <Name>.
ModifyPair Key "<Name>" Value "<NewValue>" Modify the value for the specified key.
SetReadOnly Key "<Name>" IsReadOnly {True | False} Set the read only value for the specified key.
RemovePair Key "<Name>" Remove the specified key pair.
RemoveAll n/a Remove all key value pairs.

Example

Add two key value pairs, set one to read only, and then remove it.

KeyValueMetaData * AddPair Key "MyCity" Value "Beaver Falls"

KeyValueMetaData * AddPair Key "MyState" Value "Pennsylvania"

KeyValueMetaData * SetReadOnly Key "MyCity" IsReadOnly True

KeyValueMetaData * RemovePair Key "MyCity"

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Scenarios

Version

11.2

STK 11.2.1 Programming Interface