xsi_argument.h

Go to the documentation of this file.

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

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

#ifndef __XSIARGUMENT_H__
#define __XSIARGUMENT_H__

#include <xsi_siobject.h>
#include <xsi_value.h>

namespace XSI {

class ArgumentArray ; // Forward declaration
class ArgumentHandler ;

//*****************************************************************************
//*****************************************************************************
class SICPPSDKDECL Argument : public SIObject
{
public:
    Argument();

    ~Argument();

    Argument(const CRef& in_ref);

    Argument(const Argument& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    Argument& operator=(const Argument& in_obj);

    Argument& operator=(const CRef& in_ref);

    CValue GetValue() const ;

    CStatus PutValue(const CValue&)  ;

    siArgumentFlags GetFlags() const ;

    ArgumentHandler GetHandler() const ;

    CStatus PutHandler( const CString & in_strHandler ) ;

    CStatus PutHandler( ArgumentHandler & in_Handler ) ;

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

//*****************************************************************************
//*****************************************************************************
class SICPPSDKDECL ArgumentArray : public CBase
{
    public:
    ArgumentArray();

    ~ArgumentArray();

    ArgumentArray(const CRef& in_ref);

    ArgumentArray(const ArgumentArray& in_obj);

    bool IsA( siClassID in_ClassID) const;

    siClassID GetClassID() const;

    ArgumentArray& operator=(const ArgumentArray& in_obj);

    ArgumentArray& operator=(const CRef& in_ref);

    Argument GetItem( LONG in_index ) const;

    Argument GetItem( const CString& in_name ) const;

    Argument operator[]( LONG in_index );

    const Argument operator[]( LONG in_index ) const;

    LONG GetCount() const;

    Argument Add(
                const CString& in_strName,
                const CValue& in_dftValue = CValue() ) ;

    Argument AddObjectArgument(
                const CString& in_strName ) ;

    Argument AddWithHandler(
                const CString& in_strName,
                const CString& in_strHandlerName,
                const CString& in_Default = CString()) ;

    Argument AddWithHandler(
                const CString& in_strName,
                ArgumentHandler& in_Handler,
                const CString& in_Default = CString()) ;

    Argument AddCopy( const Argument & in_src ) ;

    CStatus RemoveAll() ;

    CStatus Remove( LONG in_index ) ;

    CStatus Remove( const CString& in_strArgName ) ;
} ;

};

#endif