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
AddPairKey "<Name>" Value "<Value>"Enter the new Key name and value. Spaces are not allowed in the key <Name>.
ModifyPairKey "<Name>" Value "<NewValue>"Modify the value for the specified key.
SetReadOnlyKey "<Name>" IsReadOnly {True | False}Set the read only value for the specified key.
RemovePairKey "<Name>"Remove the specified key pair.
RemoveAlln/aRemove all key value pairs.

Examples

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"

Return message

Group membership

This command belongs to the following group(s):

Scenarios

Version

11.2