xsi_userdatamap.h

Go to the documentation of this file.

//*****************************************************************************
//*****************************************************************************

#if (_MSC_VER > 1000) || defined(SGI_COMPILER)
#pragma once
#endif

#ifndef __XSIUSERDATAMAP_H__
#define __XSIUSERDATAMAP_H__

#include <xsi_property.h>
#include <xsi_value.h>
#include <xsi_status.h>
#include <xsi_customproperty.h>
#include <xsi_userdataarray.h>
#include <xsi_bitarray.h>

namespace XSI {

//*****************************************************************************
//*****************************************************************************

class SICPPSDKDECL UserDataMap : public Property
{
public:
    UserDataMap();

    ~UserDataMap();

    UserDataMap(const CRef& in_ref);

    UserDataMap(const UserDataMap& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    UserDataMap& operator=(const UserDataMap& in_obj);

    UserDataMap& operator=(const CRef& in_ref);

    LONG GetCount() const ;

    void Clear() ;

    bool IsLittleEndian() const ;

    void PutLittleEndian( bool in_bLittleEndian ) ;

    CustomProperty  GetTemplate() const ;

    CStatus PutTemplate( const CustomProperty& in_Template ) ;

    CStatus GetItemValue( LONG in_Offset, const unsigned char *& out_buffer, UINT& out_size ) const ;

    CStatus PutItemValue( LONG in_Offset, const unsigned char * in_buffer, UINT in_size ) ;

    bool IsItemEmpty( LONG in_lOffset ) const ;

    UINT GetItemSize( LONG in_lOffset ) const ;

    void ClearItem( LONG in_Offset ) ;

    CStatus GetValues( CUserDataArray& out_data ) const;

    CStatus GetValues( CUserDataArray& out_data, CBitArray& out_elemIdx) const;

    CStatus SetValues(
        const unsigned char**   in_pValues,
        const LONG*             in_pSizeArray,
        LONG                    in_nValues,
        LONG                    in_nOffset=0);

    CStatus SetValues(
        const LONG*             in_pElements,
        const unsigned char**   in_pValues,
        const LONG*             in_pSizeArray,
        LONG                    in_nElements );

    CStatus SetFixedSizeValues(
        const unsigned char**   in_pValues,
        LONG                    in_nValues,
        LONG                    in_nSize,
        LONG                    in_nOffset=0);

    CStatus SetFixedSizeValues(
        const LONG*             in_pElements,
        const unsigned char**   in_pValues,
        LONG                    in_nElements,
        LONG                    in_nSize );

    private:
    UserDataMap * operator&() const;
    UserDataMap * operator&();
};

};
#endif // __XSIUSERDATAMAP_H__