GitResetType Class Reference

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

#include <gittask.h>

Inheritance diagram for GitResetType:

Public Member Functions
	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. More...
	GitResetType ()
	Construct a reset type object, defaulting to a Soft reset. More...
void	Get (const SdsId &Id, const char *const Name, int Position, StatusType *status, const int Flags=Git::Upper|Git::Abbrev|Git::KeepErr)
void	SetRecover ()
	Set the reset type to Recover. More...
void	SetSoft ()
	Set the reset type to Soft. More...
void	SetHard ()
	Set the reset type to Hard. More...
void	SetFull ()
	Set the reset type to Full. More...
bool	IsSoft () const
	Return true if the reset type if Soft. More...
bool	IsFull () const
	Return true if the rest type if Full. More...
bool	IsHard () const
	Return true if the reset type is Hard. More...
bool	IsRecover () const
	Return true if the reset type is Hard. More...
bool	IsInvalid () const
	Return true if there is no valid reset type. More...
	operator const char * () const
	Return the reset type as a character string. More...
Public Member Functions inherited from GitEnum
virtual	~GitEnum ()
	Destructor. More...
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. More...

Additional Inherited Members
Public Types inherited from Git
enum	{   Upper =GIT_M_ARG_UPPER, Lower =GIT_M_ARG_UPPER, KeepErr =GIT_M_ARG_KEEPERR, Abbrev = GIT_M_ARG_ABBREV,   LastBit =GIT_M_ARG_LASTBIT }

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.

Constructor & Destructor Documentation

GitResetType::GitResetType ( const SdsId &  Id, const char *const  Name, int  Position, StatusType *  status, const int  Flags = Git::Upper|Git::Abbrev|Git::KeepErr  )

inline

Construct a GitReset type from an action argument.

The specified SDS structure is examined for an item of the specified name. If it does not exist, then an item at the specified position is examined. The function attempts to set the GitReset type based on the value of this argument.

Parameters

Id	The Sds ID of the structure containing the argument.
Name	The name of the item in the structure.
Position	The Position of the item in the structure. Only used if an item of the specified name does not exist. First item is 1.
status	Inherited status
Flags	Which Git flags to Apply. Defaults to (Git::Upper|Git::Abbrev|Git::KeepErr)

References GitEnum::Get().

GitResetType::GitResetType ( )

inline

Construct a reset type object, defaulting to a Soft reset.

Member Function Documentation

bool GitResetType::IsFull ( ) const

inline

Return true if the rest type if Full.

bool GitResetType::IsHard ( ) const

inline

Return true if the reset type is Hard.

bool GitResetType::IsInvalid ( ) const

inline

Return true if there is no valid reset type.

bool GitResetType::IsRecover ( ) const

inline

Return true if the reset type is Hard.

bool GitResetType::IsSoft ( ) const

inline

Return true if the reset type if Soft.

GitResetType::operator const char * ( ) const

inline

Return the reset type as a character string.

void GitResetType::SetFull ( )

inline

Set the reset type to Full.

void GitResetType::SetHard ( )

inline

Set the reset type to Hard.

void GitResetType::SetRecover ( )

inline

Set the reset type to Recover.

Referenced by GitTask::GitTask().

void GitResetType::SetSoft ( )

inline

Set the reset type to Soft.

---

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

• gittask.h