xsi_sample.h
Go to the documentation of this file.
00001 //*****************************************************************************
00011 //*****************************************************************************
00012 
00013 #if (_MSC_VER > 1000) || defined(SGI_COMPILER)
00014 #pragma once
00015 #endif
00016 
00017 #ifndef __XSISAMPLE_H__
00018 #define __XSISAMPLE_H__
00019 
00020 #include <xsi_siobject.h>
00021 #include <xsi_longarray.h>
00022 
00023 namespace XSI {
00024 
00025 class SubComponent;
00026 class Sample;
00027 
00028 //*****************************************************************************
00059 //*****************************************************************************
00060 
00061 class SICPPSDKDECL Sample : public SIObject
00062 {
00063 public:
00065     Sample();
00066 
00068     ~Sample();
00069 
00073     Sample(const CRef& in_ref);
00074 
00078     Sample(const Sample& in_obj);
00079 
00084     bool IsA( siClassID in_ClassID) const;
00085 
00089     siClassID GetClassID() const;
00090 
00096     Sample& operator=(const Sample& in_obj);
00097 
00103     Sample& operator=(const CRef& in_ref);
00104 
00108     LONG GetIndex() const;
00109 
00113     SubComponent GetSubComponent() const;
00114 
00121     Sample Navigate(siNavigateComponentType in_siNavigate) const;
00122 
00123     private:
00124     Sample * operator&() const;
00125     Sample * operator&();
00126 };
00127 
00128 //*****************************************************************************
00159 //*****************************************************************************
00160 class SICPPSDKDECL CSampleRefArray : public CRefArray
00161 {
00162     public:
00163     CSampleRefArray();
00164 
00168     CSampleRefArray( const CSampleRefArray& in_array );
00169 
00174     CRef GetItem( LONG in_index ) const;
00175 
00180     CRef GetItem( const CString& in_name ) const;
00181 
00185     LONG GetCount() const;
00186 
00190     bool IsValid() const;
00191 
00195     CLongArray GetIndexArray() const;
00196 
00200     SubComponent GetSubComponent() const;
00201 
00209     CSampleRefArray Navigate(siNavigateComponentType in_siNavigate) const;
00210 
00211     private:
00212     void* m_ptr;
00213 };
00214 
00215 };
00216 
00217 #endif // __XSISAMPLE_H__