AAO DRAMA C++ Interface (Old style)
DRAMA C++, Depreciated, don't use for new code
Public Types | Public Member Functions | List of all members
GitResetType Class Reference

A class used to represent the type of RESET operation. More...

#include <gittask.h>

Inheritance diagram for GitResetType:
GitEnum Git

Public Types

enum  {
  Upper =GIT_M_ARG_UPPER , Lower =GIT_M_ARG_LOWER , KeepErr =GIT_M_ARG_KEEPERR , Abbrev = GIT_M_ARG_ABBREV ,
  LastBit =GIT_M_ARG_LASTBIT , KeepValErr =GIT_M_ARG_KEEPVALERR
}
 

Public Member Functions

 GitResetType ()
 Construct a reset type object, defaulting to a Soft reset.
 
 GitResetType (const SdsId &Id, const char *const Name, int Position, StatusType *status, const int Flags=Git::Upper|Git::Abbrev|Git::KeepErr)
 Construct a GitReset type from an action argument.
 
void Get (const SdsId &Id, const char *const Name, const int Position, StatusType *status, const char *Default=0, const int Flags=Git::Upper|Git::Abbrev)
 Get the value of the object from an SDS struture.
 
void Get (const SdsId &Id, const char *const Name, int Position, StatusType *status, const int Flags=Git::Upper|Git::Abbrev|Git::KeepErr)
 
bool IsFull () const
 Return true if the rest type if Full.
 
bool IsHard () const
 Return true if the reset type is Hard.
 
bool IsInvalid () const
 Return true if there is no valid reset type.
 
bool IsRecover () const
 Return true if the reset type is Hard.
 
bool IsSoft () const
 Return true if the reset type if Soft.
 
 operator const char * () const
 Return the reset type as a character string.
 
void SetFull ()
 Set the reset type to Full.
 
void SetHard ()
 Set the reset type to Hard.
 
void SetRecover ()
 Set the reset type to Recover.
 
void SetSoft ()
 Set the reset type to Soft.
 

Detailed Description

A class used to represent the type of RESET operation.

This class is used to interpet the argument passed to the GIT RESET action..

This supports the various resets normally supported by GIT tasks, being SOFT, FULL and HARD. It also supports RECOVER, which is used by GitTask to only reset failed tasks.


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