xsi_siobject.h

Go to the documentation of this file.

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

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

#ifndef __XSISIOBJECT_H__
#define __XSISIOBJECT_H__

#include <xsi_base.h>

namespace XSI {

class Application;

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

class SICPPSDKDECL SIObject : public CBase
{
public:
    SIObject();

    ~SIObject();

    SIObject(const CRef& in_ref);

    SIObject(const SIObject& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    SIObject& operator=(const SIObject& in_obj);

    SIObject& operator=(const CRef& in_ref);

    Application GetApplication() const;

    CString GetFullName() const;

    CString GetName() const;

    CStatus PutName(const CString& in_name);

    /* \deprecated Provided for backward compatibility only,
    */
    CStatus PutName(CString& in_name);

    CString GetUniqueName() const;

    CString GetType() const;

    CRef    GetParent() const;

    bool    IsEqualTo( const CRef& in_ref) const;

    CString GetHelp() const;

    CString GetOriginPath() const;

    siInstallationPath GetOrigin() const;

    CStringArray GetCategories() const;

    CRefArray GetNestedObjects() const;

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

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

    CSIObjectRefArray();

    CSIObjectRefArray( const CSIObjectRefArray& );

    ~CSIObjectRefArray();

    CSIObjectRefArray& operator=( const CSIObjectRefArray& in_refArray );

    CRef GetItem( const CString& in_name ) const;

    void Add( const CRef& in_item );

    void RemoveItem( const CString& in_name );
};

};

#endif // __XSISIOBJECT_H__