xsi_ref.h

Go to the documentation of this file.

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

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

#ifndef __XSIREF_H__
#define __XSIREF_H__


#include "sicppsdk.h"
#include "xsi_string.h"
#include "xsi_decl.h"

namespace XSI {

class CStatus;
class CValueArray;

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

class SICPPSDKDECL CRef
{
public:
    CRef();

    CRef(const CRef& in_xsiRef);

    ~CRef();

    siClassID GetClassID() const;

    bool IsA(siClassID in_classID) const;

    CString GetClassIDName() const;

    bool IsValid() const;

    operator bool() const;

    bool operator == (const CRef& in_ref) const;

    bool operator != (const CRef& in_ref ) const;

    CRef& operator = (const CRef& in_ref );

    CStatus Set(const CString& in_str);

    CString GetAsText() const;

    bool operator < ( const CRef& in_ref ) const;

    bool operator > ( const CRef& in_ref ) const;

protected:
    void* GetPtr() const;

private:
    void* m_ptr;
};

//*************************************************************************
//*************************************************************************
class SICPPSDKDECL CRefArray
{
    public:

    CRefArray(LONG in_lSize=0);

    CRefArray(const CRefArray& in_refArray);

    virtual ~CRefArray();

    CRefArray& operator=( const CRefArray& in_refArray );

    CRefArray& operator+=( const CRefArray& in_refArray );

    const CRef& operator[]( LONG in_index ) const;

    CRef& operator[]( LONG in_index );

    virtual CRef GetItem( LONG in_index ) const;

    virtual CRef GetItem( const CString& in_name ) const;

    virtual void Add( const CRef& in_item );

    virtual LONG GetCount() const;

    bool IsA(siClassID in_classID) const;

    siClassID GetClassID() const;

    CString GetClassIDName() const;

    virtual bool IsValid() const;

    operator bool() const;

    CStatus Filter( const CString& in_strType, const CStringArray& in_strFam,
        const CString& in_strObjName, CRefArray& io_array ) const;

    CStatus Find( const CString& in_strType, CRef& io_obj ) const;

    LONG Set(const CValueArray& in_valarray);

    LONG Set(const CString& in_strarray, const CString& in_sep = L"," );

    LONG Remove(const CRef& in_ref );

    void Clear(void);

    CString GetAsText() const;

    CStatus Resize( LONG in_size );

    protected:
    void SetPtr( void* p=NULL, LONG id=siUnknownClassID );
    void* GetPtr() const;
    LONG GetID()const;

    private:
    LONG    m_id;
    mutable void*   m_ptr;
};

SICPPSDKDECL CRef ConvertObject( void* in_pAuto );

SICPPSDKDECL void* ConvertObject( const CRef& in_obj );

SICPPSDKDECL bool HasClassID( CRef&, LONG );
SICPPSDKDECL bool CanSubClass( CRef&, LONG );

};

#endif // __XSIREF_H__