xsi_iceportstate.h

Go to the documentation of this file.

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

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

#ifndef __XSIICEPORTSTATE_H__
#define __XSIICEPORTSTATE_H__

namespace XSI {

class ICENodeContext;
//*****************************************************************************
//*****************************************************************************

class SICPPSDKDECL CICEPortState
{
    public:
    friend class ICENodeContext;

    enum DirtyState
    {
        siTypeDirtyState    = 1<<0, 
        siDataDirtyState    = 1<<1, 
        siTimeDirtyState    = 1<<2, 
        siAnyDirtyState     = siTypeDirtyState|siDataDirtyState|siTimeDirtyState 
    };

    CICEPortState( ICENodeContext& in_ctxt, ULONG in_nInputPortID, ULONG in_nInstanceIndex=0 ) ;

    CICEPortState();

    ~CICEPortState();

    CICEPortState(const CICEPortState& in_obj);

    bool operator == (const CICEPortState& in_obj) const;

    bool operator != (const CICEPortState& in_obj) const;

    CICEPortState& operator = (const CICEPortState& in_obj) ;

    bool IsValid() const;

    bool IsDirty( unsigned short in_flag=siAnyDirtyState ) const;

    void ClearState( );

    protected:
    CStatus Init( const ICENodeContext& in_ctxt, ULONG in_nInputPortID, ULONG in_nGroupInstID );

    void* m_pCtxt;
    ULONG m_nInputPortID;
};

};
#endif // __XSIICEPORTSTATE_H__