ks_component_member
component object encapsulating the extraction of a component from within a composite. given an instance of a kassiopeia object, a string can be given to it to request a component. if a matching association between the string and a member function of the parent’s class is found, a component is created which binds the result of calling the member function of the parent into a kassiopeia object. typically components are built from getter functions, and may be chained together by using another component as parent, as in the example.
<ks_component_member>KSComponentMemberDatacomponent_member, outputAttribute |
Type |
Description |
|---|---|---|
|
|
the name of the class member to use. available members depend completely on the parent’s final type. |
|
|
the name of the extracted component. |
|
|
the name of the composite. Refers to the name of any |
Example:
<output name="step_final_particle" parent="step" field="final_particle"/>
<output name="step_final_particle_position" parent="step_final_particle" field="position"/>
<output name="step_final_particle_position_z" parent="step_final_particle_position" field="z"/>
Used as:
<ks_component_member>,<output>in <kassiopeia><component_member>,<output>in <ks_component_group>
More information
Appears in the documentation:
Output (Output description)
Understanding Simulation Output (Groups and fields, Output structure)
Used in example configurations: