IRouteEditorStateStack Class Reference

Route editor state stack interface. More...

#include <route_storage_interfaces.h>

Inheritance diagram for IRouteEditorStateStack:

Public Member Functions
virtual SDKResult SDK_CALLTYPE	PushCurrentState ()=0 throw ()
	Stores the current state of the route editor.
virtual SDKResult SDK_CALLTYPE	PopState ()=0 throw ()
	Reverts the route editor state.
virtual SDKResult SDK_CALLTYPE	GetStackSize (SDKUInt32 &size) const =0 throw ()
	Returns the stack size. More...
virtual SDKResult SDK_CALLTYPE	SetStackSizeLimit (SDKUInt32 size_limit)=0 throw ()
	Set the stack size limit. More...
Public Member Functions inherited from ISDKComponent
virtual SDKAtomicRefCount SDK_CALLTYPE	AddRef () const =0 throw ()
	Increments the reference count for an interface on a component.
virtual SDKAtomicRefCount SDK_CALLTYPE	Release () const =0 throw ()
	Decrements the reference count for an interface on a component.
virtual SDKResult SDK_CALLTYPE	GetInterface (const InterfaceId &id, void **obj_ptr)=0 throw ()
	Returns pointers to the supported interfaces on a component.
template<typename _Itf >
SDKResult	GetInterface (_Itf **obj_ptr) throw ()
	Returns pointers to the supported interfaces on a component.

Detailed Description

Route editor state stack interface.

Member Function Documentation

GetStackSize()

virtual SDKResult SDK_CALLTYPE GetStackSize ( SDKUInt32 &  size ) const throw ( )

pure virtual

Returns the stack size.

Parameters

[out]

size

Address of a variable that receives the stack size.

Returns

kSDKResult_Succeeded

SetStackSizeLimit()

virtual SDKResult SDK_CALLTYPE SetStackSizeLimit ( SDKUInt32  size_limit ) throw ( )

pure virtual

Set the stack size limit.

Parameters

[in]

size_limit

The limit of the stack size.

Returns

kSDKResult_Succeeded

---

The documentation for this class was generated from the following file:

• route_storage_interfaces.h