sdaiPutAttr

valueType argument to specify what type of data caller wants to put Table 1 shows type of buffer the caller should provide depending on the valueType for sdaiPutAttr, and it works similarly for all put-functions. Note: with SDAI API it is impossible to check buffer type at compilation or execution time and this is responsibility of a caller to ensure that requested valueType is matching with the value argument, a mismatch will lead to unpredictable results.

Table 1 – Required value buffer depending on valueType (on the example of sdaiPutAttr but valid for all put-functions)

valueType               C/C++                                                       C#

sdaiINTEGER             int_t val = 123;                                            int_t val = 123;
                        sdaiPutAttr (inst, attr, sdaiINTEGER, &val);                ifcengine.sdaiPutAttr (inst, attr, ifcengine.sdaiINTEGER, ref val);

sdaiREAL or sdaiNUMBER  double val = 123.456;                                       double val = 123.456;
                        sdaiPutAttr (inst, attr, sdaiREAL, &val);                   ifcengine.sdaiPutAttr (inst, attr, ifcengine.sdaiREAL, ref val);

sdaiBOOLEAN             bool val = true;                                            bool val = true;
                        sdaiPutAttr (inst, attr, sdaiBOOLEAN, &val);                ifcengine.sdaiPutAttr (inst, attr, ifcengine.sdaiBOOLEAN, ref val);

sdaiLOGICAL             const TCHAR* val = "U";                                     string val = "U";
                        sdaiPutAttr (inst, attr, sdaiLOGICAL, val);                 ifcengine.sdaiPutAttr (inst, attr, ifcengine.sdaiLOGICAL, val);

sdaiENUM                const TCHAR* val = "NOTDEFINED";                            string val = "NOTDEFINED";
                        sdaiPutAttr (inst, attr, sdaiENUM, val);                    ifcengine.sdaiPutAttr (inst, attr, ifcengine.sdaiENUM, val);

sdaiBINARY              const TCHAR* val = "0123456ABC";                            string val = "0123456ABC";
                        sdaiPutAttr (inst, attr, sdaiBINARY, val);                  ifcengine.sdaiPutAttr (inst, attr, ifcengine.sdaiBINARY, val);

sdaiSTRING              const char* val = "My Simple String";                       string val = "My Simple String";
                        sdaiPutAttr (inst, attr, sdaiSTRING, val);                  ifcengine.sdaiPutAttr (inst, attr, ifcengine.sdaiSTRING, val);

sdaiUNICODE             const wchar_t* val = L"Any Unicode String";                 string val = "Any Unicode String";
                        sdaiPutAttr (inst, attr, sdaiUNICODE, val);                 ifcengine.sdaiPutAttr (inst, attr, ifcengine.sdaiSTRING, val);

sdaiEXPRESSSTRING       const char* val = "EXPRESS format, i.e. \\X2\\00FC\\X0\\";  string val = "EXPRESS format, i.e. \\X2\\00FC\\X0\\";
                        sdaiPutAttr (inst, attr, sdaiEXPRESSSTRING, val);           ifcengine.sdaiPutAttr (inst, attr, ifcengine.sdaiEXPRESSSTRING, val);

sdaiINSTANCE            SdaiInstance val = sdaiCreateInstanceBN (model, "IFCSITE"); int_t val = ifcengine.sdaiCreateInstanceBN (model, "IFCSITE");
                        sdaiPutAttr (inst, attr, sdaiINSTANCE, val);                ifcengine.sdaiPutAttr (inst, attr, ifcengine.sdaiINSTANCE, val);

sdaiAGGR                SdaiAggr val = sdaiCreateAggr (inst, 0);                    int_t val = sdaiCreateAggr (inst, 0);
                        sdaiAppend (val, sdaiINSTANCE, inst);                       ifcengine.sdaiAppend (val, ifcengine.sdaiINSTANCE, inst);
                        sdaiPutAttr (inst, attr, sdaiAGGR, val);                    ifcengine.sdaiPutAttr (inst, attr, ifcengine.sdaiAGGR, val);

sdaiADB                 int_t integerValue = 123;                                   int_t integerValue = 123;   
                        SdaiADB val = sdaiCreateADB (sdaiINTEGER, &integerValue);   int_t val = ifcengine.sdaiCreateADB (ifcengine.sdaiINTEGER, ref integerValue);
                        sdaiPutADBTypePath (val, 1, "IFCINTEGER");                  ifcengine.sdaiPutADBTypePath (val, 1, "IFCINTEGER");
                        sdaiPutAttr (inst, attr, sdaiADB, val);                     ifcengine.sdaiPutAttr (inst, attr, ifcengine.sdaiADB, val); 
                        sdaiDeleteADB (val);                                        ifcengine.sdaiDeleteADB (val);
TCHAR is “char” or “wchar_t” depending on setStringUnicode. (Non-standard behavior) sdaiLOGICAL behaves differently from ISO 10303-24-2001: it expects char* while standard declares int_t (Non-standard extension) sdiADB in C++ has an option to work without sdaiCreateEmptyADB and sdaiDeleteADB as shown in the table
Table 2 - valueType can be requested depending on actual model data.

valueType       Works for following values in the model
                  integer      real     .T. or .F.     .U.      other enum    binary      string     instance      list      $ (empty)
sdaiINTEGER         Yes          .           .           .           .           .           .           .           .           .
sdaiREAL             .          Yes          .           .           .           .           .           .           .           .
sdaiNUMBER           .          Yes          .           .           .           .           .           .           .           .
sdaiBOOLEAN          .           .          Yes          .           .           .           .           .           .           .
sdaiLOGICAL          .           .          Yes         Yes          .           .           .           .           .           .
sdaiENUM             .           .          Yes         Yes         Yes          .           .           .           .           .
sdaiBINARY           .           .           .           .           .          Yes          .           .           .           .
sdaiSTRING           .           .           .           .           .           .          Yes          .           .           .
sdaiUNICODE          .           .           .           .           .           .          Yes          .           .           .
sdaiEXPRESSSTRING    .           .           .           .           .           .          Yes          .           .           .
sdaiINSTANCE         .           .           .           .           .           .           .          Yes          .           .
sdaiAGGR             .           .           .           .           .           .           .           .          Yes          .
sdaiADB             Yes         Yes         Yes         Yes         Yes         Yes         Yes         Yes         Yes          .

Syntax

//
//   Strong typing definition
//
void            sdaiPutAttr(
                        SdaiInstance            instance,
                        const SdaiAttr          attribute,
                        SdaiPrimitiveType       valueType,
                        const void              * value
                    );

static  inline  void    sdaiPutAttr(
                                SdaiInstance            instance,
                                const SdaiAttr          attribute,
                                SdaiPrimitiveType       valueType,
                                SdaiInstance            value
                            )
{
    return  sdaiPutAttr(
                    instance,
                    attribute,
                    valueType,
                    (const void*) value
                );
}


//
//   Weak typing definition
//
void    __declspec(dllexport) __stdcall sdaiPutAttr(
                                                int_t                   instance,
                                                const void              * attribute,
                                                int_t                   valueType,
                                                const void              * value
                                            );

static  inline  void    sdaiPutAttr(
                                int_t                   instance,
                                const void              * attribute,
                                int_t                   valueType,
                                int_t                   value
                            )
{
    return  sdaiPutAttr(
                    instance,
                    attribute,
                    valueType,
                    (const void*) value
                );
}
    

Property instance

Size: 32 bit / 4 byte (value)
...

Property attribute

Size: 32 bit / 4 byte (reference)
...

Property valueType

Size: 32 bit / 4 byte (value)
...

Property value

Size: 32 bit / 4 byte (reference)
...

Example (based on pure API calls)

Here you can find code snippits that show how the API call sdaiPutAttr can be used.

#include    "./include/ifcengine.h"
int_t   * localPutAttrBN(int_t instance, char * attributeName)
{
    //
    //  This function is an alternative to the API call sdaiCreateAggrBN()
    //  based on sdaiCreateAggr().
    //
    //  Use of sdaiCreateAggr() can lead to performance improvement compared to sdaiCreateAggrBN().
    //
    int_t   instanceType = sdaiGetInstanceType(instance);
    void    * attribute = sdaiGetAttrDefinition(instanceType, attributeName);

    return  sdaiPutAttr(instance, attribute);
}