xsi_sample.h

Go to the documentation of this file.

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

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

#ifndef __XSISAMPLE_H__
#define __XSISAMPLE_H__

#include <xsi_siobject.h>
#include <xsi_longarray.h>

namespace XSI {

class SubComponent;
class Sample;

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

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

    ~Sample();

    Sample(const CRef& in_ref);

    Sample(const Sample& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    Sample& operator=(const Sample& in_obj);

    Sample& operator=(const CRef& in_ref);

    LONG GetIndex() const;

    SubComponent GetSubComponent() const;

    Sample Navigate(siNavigateComponentType in_siNavigate) const;

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

//*****************************************************************************
//*****************************************************************************
class SICPPSDKDECL CSampleRefArray : public CRefArray
{
    public:
    CSampleRefArray();

    CSampleRefArray( const CSampleRefArray& in_array );

    CRef GetItem( LONG in_index ) const;

    CRef GetItem( const CString& in_name ) const;

    LONG GetCount() const;

    bool IsValid() const;

    CLongArray GetIndexArray() const;

    SubComponent GetSubComponent() const;

    CSampleRefArray Navigate(siNavigateComponentType in_siNavigate) const;

    private:
    void* m_ptr;
};

};

#endif // __XSISAMPLE_H__