Isis::ViewportBufferAction Class Reference

#include <ViewportBufferAction.h>

Inheritance diagram for Isis::ViewportBufferAction:

Collaboration diagram for Isis::ViewportBufferAction:

Public Types
enum	ActionType { none, transform, fill, stretch }
	This uniquely identifies which child is instantiated. More...

Public Member Functions
	ViewportBufferAction ()
	Creates a new viewport buffer action. More...
virtual	~ViewportBufferAction ()
	Destructor. More...
virtual ActionType	getActionType ()
	Returns the instantiated type. More...
bool	started ()
	Returns true if this is an action that takes time and has begun. More...
void	started (bool started)
	Sets started. More...
virtual void	stop ()
	Cancels the process, used if reinitialize requested for example. More...

Private Member Functions
	ViewportBufferAction (const ViewportBufferAction &other)
	No copying these. More...
ViewportBufferAction &	operator= (const ViewportBufferAction &other)
	No assigning these. More...

Private Attributes
bool	p_started
	True if this action has begun. More...

Detailed Description

Author

????-??-?? Unknown

Definition at line 18 of file ViewportBufferAction.h.

Member Enumeration Documentation

ActionType

enum Isis::ViewportBufferAction::ActionType

This uniquely identifies which child is instantiated.

Enumerator
none	Parent was instantiated.
transform	ViewportBufferTransform.
fill	ViewportBufferFill.
stretch	ViewportBufferStretch.

Definition at line 26 of file ViewportBufferAction.h.

Constructor & Destructor Documentation

ViewportBufferAction() [1/2]

Isis::ViewportBufferAction::ViewportBufferAction

(

)

Creates a new viewport buffer action.

Definition at line 15 of file ViewportBufferAction.cpp.

References p_started.

~ViewportBufferAction()

Isis::ViewportBufferAction::~ViewportBufferAction ( )

virtual

Destructor.

Definition at line 22 of file ViewportBufferAction.cpp.

ViewportBufferAction() [2/2]

Isis::ViewportBufferAction::ViewportBufferAction ( const ViewportBufferAction &  other )

private

No copying these.

Parameters

other

Member Function Documentation

getActionType()

virtual ActionType Isis::ViewportBufferAction::getActionType ( )

inlinevirtual

Returns the instantiated type.

Reimplemented in Isis::ViewportBufferTransform, Isis::ViewportBufferStretch, and Isis::ViewportBufferFill.

Definition at line 34 of file ViewportBufferAction.h.

References none.

Referenced by Isis::ViewportBuffer::actionsPreserveData(), Isis::ViewportBuffer::DataReady(), Isis::ViewportBuffer::doQueuedActions(), Isis::ViewportBuffer::enqueueAction(), Isis::ViewportBuffer::reinitialize(), Isis::ViewportBuffer::reinitializeActionExists(), and Isis::ViewportBuffer::totalUnfilledArea().

operator=()

ViewportBufferAction& Isis::ViewportBufferAction::operator= ( const ViewportBufferAction &  other )

private

No assigning these.

Parameters

other

Returns

ViewportBufferAction&

started() [1/2]

bool Isis::ViewportBufferAction::started ( )

inline

Returns true if this is an action that takes time and has begun.

Definition at line 39 of file ViewportBufferAction.h.

References p_started.

Referenced by Isis::ViewportBuffer::DataReady(), Isis::ViewportBuffer::doQueuedActions(), Isis::ViewportBuffer::reinitialize(), started(), and Isis::ViewportBuffer::startFillAction().

started() [2/2]

void Isis::ViewportBufferAction::started ( bool  started )

inline

Sets started.

Parameters

started

True if starting

Definition at line 48 of file ViewportBufferAction.h.

References p_started, and started().

stop()

virtual void Isis::ViewportBufferAction::stop ( )

inlinevirtual

Cancels the process, used if reinitialize requested for example.

Reimplemented in Isis::ViewportBufferFill.

Definition at line 53 of file ViewportBufferAction.h.

Member Data Documentation

p_started

bool Isis::ViewportBufferAction::p_started

private

True if this action has begun.

Definition at line 73 of file ViewportBufferAction.h.

Referenced by started(), and ViewportBufferAction().

---

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

• src/qisis/objs/CubeViewport/ViewportBufferAction.h
• src/qisis/objs/CubeViewport/ViewportBufferAction.cpp