ks_command_member

command object encapsulating a request to combine or change simulation objects. given an instance of a kassiopeia object, a string can be given to it to request a command. if a matching association between the string and a member function of the parent’s class is found, a command is created which binds the parent, its member, and a given child object together. typically commands come in add/remove or set/clear pairs which compose objects together as in the example, or get/set pairs by which an object’s configuration may be altered.

XML element: <ks_command_member>
C++ type: KSCommandMemberData
Also available as: command
Attributes

Attribute

Type

Description

child

string

the name of the child object to bind with the member.

Refers to the name of any KSComponent object.

field

string

the name of the parent class member to use. available members depend completely on the parent’s final type.

name

string

the name of the resulting command object.

parent

string

the name of the parent object.

Refers to the name of any KSComponent object.

Example:

<ks_command_member name="command_remove_cyclotron" parent="trajectory_exact" field="remove_control" child="control_cyclotron"/>

Used as:

Can be referenced by:

More information

Appears in the documentation:

Used in example configurations: