edmiRemoteCreateTypedAggr

 
Creates an empty typed aggregate instance on an explicit attribute of an instance within an edmModel in the remote EDMdatabase^. The aggregate attribute is identified by its attributeId.
Typed aggregates are required when the attribute domain definition in the edmModels underlying Express Schema does not uniquely define the type of the elements to be held by the aggregate. This may only happen when the declared aggregate elements are of type SELECT.
When creating a typed aggregate, a struct of type tSdaiSelect with a type specification of the aggregate elements must be supplied. A numeric aggregateID will be returned from the function. This id uniquely identifies the typed aggregate within the remote EDMdatabase^. The aggregateID will remain unchanged throughout the lifetime of the aggregate and may be used to identify the aggregate in subsequent calls to EDMinterface^ API functions. The type of aggregate to be created is determined by the attribute declaration within the underlying Express Schema of the edmModel.
The attribute that will own the aggregate is specified by the <attributeName> argument. If the attribute name is not unique within the actual instance, it must be qualified with the name of the entity from which the attribute was originally inherited.
An aggregateID may not be handled as a plain data value. Aggregates must be created on the explicit attributes of entities that have been predeclared to hold them in the underlying Express Schema of the edmModel. An aggregateId may be retrieved by an EDMinterface^ Get operation, but it may not be used to populate other attributes by means of EDMinterface^ Put operations.
Related functions: edmiRemoteCreateTypedAggrBN
Header:
#include "sdai.h"
Prototype:
EdmiError edmiRemoteCreateTypedAggr(SdaiServerContext serverContextId,
                                     SdaiAppInstance   currInst,
                                     SdaiAttr          attrId,
                                     SdaiSelect        pSel,
                                     SdaiAggr          *aggrId,
                                     SdaiInvocationId  *edmiInvocationId);
 
Arguments:

Returns:
A completion code of datatype EdmiError is the returned function value. The completion code has the following values:
Completion code = 0 : Operation successfully performed.
Completion code != 0: Error in operation. Completion code is an _EDMinterface^_ error code. Use edmiGetErrorText to get the error text corresponding to the error code.
Example:
/*
SCHEMA Accounts 
TYPE tUSD = REAL; END_TYPE; 
TYPE tEUR = REAL; END_TYPE; 
TYPE tNOK = REAL; END_TYPE; 
TYPE tAmount = SELECT (tUSD, tEUR, tNOK); END_TYPE; 
 
ENTITY Turnover; 
Year 
Sales : ARRAY [1:12] OF tAmount; 
END_ENTITY; 
END_SCHEMA; 
*/
 
EdmiError rstat;
SdaiServerContext myContext;
SdaiAggr aggrId;
SdaiType tAmountId;
SdaiInstance instId;
SdaiAttr attrId;
tSdaiSelect sel;
SdaiSelect salesAmount = &sel;
 
/* Create Server Context */
rstat = edmiDefineServerContext("MyContext",
"Johnny", "Supervisor", "cf37ftr", 
"TCP", "9090", "MyServerHost", 
NULL, NULL, NULL, NULL, NULL, &myContext); 
 
/* Create instance of sales */
rstat = edmiRemoteCreateInstanceAndPutAttrsBN(myContext,
"AdminRepository", "Economy", 
"Turnover", 0, &instId, NULL); 
 
/* Get the attribute Id */
rstat = edmiRemoteGetAttrDefinitionBN(myContext, "Accounts",
"Turnover", "Sales", &attrId, NULL); 
 
/* Get the type Id of tAmount */
rstat = edmiRemoteGetDefinedTypeBN(myContext, "Accounts",
"tAmount", &tAmountId, NULL); 
 
/* Create typed aggregate */
salesAmount->nTypes = 1;
salesAmount->type = sdaiREAL;
salesAmount->typeList = &tAmountId;
salesAmount->value.realVal = 0;
rstat = edmiRemoteCreateTypedAggr(myContext,
instId, attrId, salesAmount,  
&aggrId, NULL); 
. . .