AAO DRAMA/DRAMA2 C++ Interface
DRAMA C++11 and later interface

◆ CreateArgCmdStruct() [1/2]

template<typename ContainerType >
static Id drama::sds::Id::CreateArgCmdStruct ( const ContainerType values,
const std::string &  name = "ArgStructure" 
)
inlinestatic

Factory constructor which creates a new "Arg" style SDS structure in the DRAMA Command style.

This static factory drama::sds::Id constructor creates a new top level SDS item of type SDS_STRUCT. This style of structure is commonly used for action arguments within DRAMA.

It then uses the values supplied in the values argument to create a typical DRAMA command argument structure.

Version which allows the values to be supplied in a Container. There is also an overload which allows values to be supplied in an initializer list.

See also
ArgNew()
drama::sds::AddToArgCmdStruct()
Template Parameters
ContainerTypeFor the container itself, any acceptable to a "for" loop with "auto" range should work (so any STL container and C style arrays). The item within the container must be acceptable to the drama::sds::Id::Put() with name methods, e.g. bool, char, short, unsigned short, INT32, UINT32, INT64, UINT64, float and double. Also the string representation std::string.
Parameters
valuesThe values to be inserted into the structure.
nameThe name for the structure. The default is what is normally supplied by the ArgNew() function, but any name acceptable to SDS can be specified.
Returns
An Id providing a reference to the structure.

References CreateArgStruct(), and drama::CreateRunDramaTask().

Referenced by CreateArgCmdStruct(), drama::Path::GetParam(), drama::Path::GetParamWaitUntil(), and drama::Path::MonitorCancel().