USGS

Isis 3.0 Object Programmers' Reference

 Home

Isis::ViewportBufferAction Class Reference

#include <ViewportBufferAction.h>

Inheritance diagram for Isis::ViewportBufferAction:
Inheritance graph
[legend]
Collaboration diagram for Isis::ViewportBufferAction:
Collaboration graph
[legend]

List of all members.

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.
virtual ~ViewportBufferAction ()
 Destructor.
virtual ActionType getActionType ()
 Returns the instantiated type.
bool started ()
 Returns true if this is an action that takes time and has begun.
void started (bool started)
 Sets started.
virtual void stop ()
 Cancels the process, used if reinitialize requested for example.

Private Member Functions

 ViewportBufferAction (const ViewportBufferAction &other)
 No copying these.
ViewportBufferAction & operator= (const ViewportBufferAction &other)
 No assigning these.

Private Attributes

bool p_started
 True if this action has begun.

Detailed Description

Author:
????-??-?? Unknown

For internal use only.

Definition at line 11 of file ViewportBufferAction.h.

Member Enumeration Documentation

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 19 of file ViewportBufferAction.h.

Constructor & Destructor Documentation

Isis::ViewportBufferAction::ViewportBufferAction (  ) 

Creates a new viewport buffer action.

Definition at line 7 of file ViewportBufferAction.cpp.

References p_started.

Isis::ViewportBufferAction::~ViewportBufferAction (  )  [virtual]

Destructor.

Definition at line 14 of file ViewportBufferAction.cpp.

Isis::ViewportBufferAction::ViewportBufferAction ( const ViewportBufferAction &  other  )  [private]

No copying these.

Parameters:
other 

Member Function Documentation

virtual ActionType Isis::ViewportBufferAction::getActionType (  )  [inline, virtual]

Returns the instantiated type.

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

Definition at line 27 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().

ViewportBufferAction& Isis::ViewportBufferAction::operator= ( const ViewportBufferAction &  other  )  [private]

No assigning these.

Parameters:
other 
Returns:
ViewportBufferAction&
void Isis::ViewportBufferAction::started ( bool  started  )  [inline]

Sets started.

Parameters:
started True if starting

Definition at line 41 of file ViewportBufferAction.h.

References p_started.

bool Isis::ViewportBufferAction::started (  )  [inline]

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

Definition at line 32 of file ViewportBufferAction.h.

References p_started.

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

virtual void Isis::ViewportBufferAction::stop (  )  [inline, virtual]

Cancels the process, used if reinitialize requested for example.

Reimplemented in Isis::ViewportBufferFill.

Definition at line 46 of file ViewportBufferAction.h.

Member Data Documentation

bool Isis::ViewportBufferAction::p_started [private]

True if this action has begun.

Definition at line 66 of file ViewportBufferAction.h.

Referenced by started(), and ViewportBufferAction().

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