Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::KeyValueTreeTransformRuleBuilder::AfterFrom< FromType > Class Template Reference

#include <gromacs/utility/keyvaluetreetransform.h>

+ Inheritance diagram for gmx::KeyValueTreeTransformRuleBuilder::AfterFrom< FromType >:
+ Collaboration diagram for gmx::KeyValueTreeTransformRuleBuilder::AfterFrom< FromType >:

Description

template<typename FromType>
class gmx::KeyValueTreeTransformRuleBuilder::AfterFrom< FromType >

Properties that can be specified after from().

Template Parameters
FromTypeType specified for from() to map from.

Public Member Functions

 AfterFrom (KeyValueTreeTransformRuleBuilder *builder)
 Creates a parameter provider object within given builder.
 
template<typename ToType >
ToValue< FromType, ToType > to (const KeyValueTreePath &path)
 Specifies a rule that maps to a value at given path. More...
 
ToObject< FromType > toObject (const KeyValueTreePath &path)
 Specifies a rule that maps to an object (collection of named values) at given path. More...
 

Additional Inherited Members

- Protected Member Functions inherited from gmx::KeyValueTreeTransformRuleBuilder::Base
 Base (KeyValueTreeTransformRuleBuilder *builder)
 Creates a parameter provider object within given builder.
 
- Protected Attributes inherited from gmx::KeyValueTreeTransformRuleBuilder::Base
KeyValueTreeTransformRuleBuilderbuilder_
 The parent builder.
 

Member Function Documentation

template<typename FromType >
template<typename ToType >
ToValue<FromType, ToType> gmx::KeyValueTreeTransformRuleBuilder::AfterFrom< FromType >::to ( const KeyValueTreePath path)
inline

Specifies a rule that maps to a value at given path.

Template Parameters
ToTypeType to map to.
Parameters
[in]pathPath to map to.

It is an error if multiple rules map to the same path, or to a parent path of the target of an existing rule. Note that it is possible to have a to() rule map to a child of a toObject() rule, provided that the path is not created by the object rule.

template<typename FromType >
ToObject<FromType> gmx::KeyValueTreeTransformRuleBuilder::AfterFrom< FromType >::toObject ( const KeyValueTreePath path)
inline

Specifies a rule that maps to an object (collection of named values) at given path.

Parameters
[in]pathPath to map to.

It is an error if multiple rules map to the same path, or to a parent path of the target of an existing rule. However, it is allowed to have two toObject() rules map to the same path, provided that the properties they produce are distinct.


The documentation for this class was generated from the following file: