ShCmdNode Class Reference

Shell command node class. More...

#include <dynashell.h>

Public Types
enum	NodeType {   NodeTypeNull,   NodeTypeCmd,   NodeTypeMap }
	Node type.

Public Member Functions
	ShCmdNode ()
	Default constructor.
	ShCmdNode (DynaShellCmd *pCmd)
	Shell command initialization constructor. More...
	ShCmdNode (ShCmdMap *pMap)
	Map of commands initialization constructor. More...
	~ShCmdNode ()
	Default destructor.
ShCmdNode &	operator= (DynaShellCmd *rhs)
	Shell command assignment operator. More...
ShCmdNode &	operator= (ShCmdMap *rhs)
	Shell map assignment operator. More...
DynaShellCmd *	GetCmd ()
	Get command object. More...
ShCmdMap *	GetMap ()
	Get map object. More...
string	GetMapBrief ()
void	SetMapBrief (const string &strBrief)
bool	IsNull ()
	Test if node type is null. More...
bool	IsCmd ()
	Test if node type is shell command. More...
bool	IsMap ()
	Test if node type is map of commands. More...

Protected Attributes
NodeType	m_eType
	node type
union {
DynaShellCmd *   m_pCmd
	pointer to allocated shell command
ShCmdMap *   m_pMap
	pointer to allocated map of commands
}	m_obj
	node object
string	m_strMapBrief
	map brief description

Detailed Description

Shell command node class.

Each node holds either a command or a map of commands.

Definition at line 119 of file dynashell.h.

Constructor & Destructor Documentation

ShCmdNode::ShCmdNode ( DynaShellCmd *  pCmd )

inline

Shell command initialization constructor.

Parameters

pCmd	Allocated shell command.

Definition at line 141 of file dynashell.h.

  {
    m_obj.m_pCmd  = pCmd;
    m_eType = NodeTypeCmd;
  }

ShCmdNode::ShCmdNode ( ShCmdMap *  pMap )

inline

Map of commands initialization constructor.

Parameters

pMap	Allocated map of commands.

Definition at line 152 of file dynashell.h.

  {
    m_obj.m_pMap  = pMap;
    m_eType = NodeTypeMap;
  }

Member Function Documentation

DynaShellCmd* ShCmdNode::GetCmd ( )

inline

Get command object.

Returns

Pointer to shell command.

Definition at line 196 of file dynashell.h.

Referenced by DynaShellCmdHelp::Exec().

  {
    return m_eType == NodeTypeCmd?  m_obj.m_pCmd: NULL;
  }

ShCmdMap* ShCmdNode::GetMap ( )

inline

Get map object.

Returns

Pointer to map of commands.

Definition at line 206 of file dynashell.h.

Referenced by DynaShellCmdHelp::Exec().

  {
    return m_eType == NodeTypeMap?  m_obj.m_pMap: NULL;
  }

bool ShCmdNode::IsCmd ( )

inline

Test if node type is shell command.

Returns

Returns true or false.

Definition at line 243 of file dynashell.h.

Referenced by DynaShellCmdHelp::Exec().

{ return m_eType == NodeTypeCmd; }

bool ShCmdNode::IsMap ( )

inline

Test if node type is map of commands.

Returns

Returns true or false.

Definition at line 250 of file dynashell.h.

Referenced by DynaShellCmdHelp::Exec().

{ return m_eType == NodeTypeMap; }

bool ShCmdNode::IsNull ( )

inline

Test if node type is null.

Returns

Returns true or false.

Definition at line 236 of file dynashell.h.

{ return m_eType == NodeTypeNull; }

ShCmdNode& ShCmdNode::operator= ( DynaShellCmd *  rhs )

inline

Shell command assignment operator.

Parameters

rhs	Pointer to allocated shell command right hand side.

Returns

Reference to this.

Definition at line 170 of file dynashell.h.

References m_pCmd.

  {
    m_obj.m_pCmd  = rhs;
    m_eType = NodeTypeCmd;
    return *this;
  }

ShCmdNode& ShCmdNode::operator= ( ShCmdMap *  rhs )

inline

Shell map assignment operator.

Parameters

rhs	Pointer to allocated map of commands right hand side.

Returns

Reference to this.

Definition at line 184 of file dynashell.h.

References m_pMap.

  {
    m_obj.m_pMap  = rhs;
    m_eType = NodeTypeMap;
    return *this;
  }

---

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

• dynashell/dynashell.h