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

◆ CreateFromSdsIdType()

static Id drama::sds::Id::CreateFromSdsIdType ( const SdsIdType  item,
const bool  free = false,
const bool  del = false,
const bool  readfree = false 
)
static

Factory constructor method that constructs an sds::Id item from an existing C language SDS id.

This static factory sds::Id constructor that takes an existing SDS ID (C style) and creates an sds::Id class object which refers to that SDS id. You must explicitly specify if the item is to be free-ed and/or deleted when the object's destructor is invoked, and what you do depends on when what other code may do with item. The del and readfree are mutually exclusive, through this is currently not checked in this implementation.

Parameters
itemThe SdsIdType of the item to be wrapped in an sds::Id.
freeSet true to invoke SdsFreeId() on the ID when the object is destroyed. The default is false.
delSet true to invoke SdsDelete() on the ID when the object is destroyed. The default is false.
readfreeSet true to invoke SdsReadFree() on the ID when the object is destroyed. The default is false.
Returns
An Id providing a reference to the structure.

Referenced by drama::ArrayParameter< SDS_T >::ArrayParameter(), drama::Parameter< SDS_T >::Parameter(), and drama::EntryInfo::Argument().