Main Page | Class Hierarchy | Class List | File List | Class Members | File Members | Related Pages

NewSimulatorEntityPath Class Reference

Wrapper class for entity path. More...

#include <new_sim_entity.h>

List of all members.

Public Member Functions

 NewSimulatorEntityPath ()
 Constructor.
 NewSimulatorEntityPath (const SaHpiEntityPathT &entity_path)
 Constructor to fill the class with an entity path.
 operator SaHpiEntityPathT ()
 return the HPI structure
void SetEntry (int idx, SaHpiEntityTypeT type, SaHpiEntityLocationT instance)
 Set an entry on a fix position.
SaHpiEntityTypeT GetEntryType (int idx)
 Return the type of entity on position idx.
void SetEntryType (int idx, SaHpiEntityTypeT type)
 Set entry type on position idx.
SaHpiEntityLocationT GetEntryInstance (int idx)
 Get entry instance for position idx.
void SetEntryInstance (int idx, SaHpiEntityLocationT instance)
 Set entry instance on position idx.
void AppendRoot (int idx)
 Append a root entity on position idx.
bool FromString (const char *str)
 Encode an entity path to a string.
NewSimulatorEntityPathoperator+= (const NewSimulatorEntityPath &epath)
 Operator to add an entity path on an existing path.
bool operator== (const NewSimulatorEntityPath &epath) const
 Operator for equal comparision of two entity path.
bool operator!= (const NewSimulatorEntityPath &epath) const
 Operator for not equal comparision of two entity path.

Public Attributes

SaHpiEntityPathT m_entity_path
 Holding the entityPath.


Detailed Description

Wrapper class for entity path.


Constructor & Destructor Documentation

NewSimulatorEntityPath::NewSimulatorEntityPath const SaHpiEntityPathT &  entity_path  ) 
 

Constructor to fill the class with an entity path.

Parameters:
entity_path Address of entity path to be set internally


Member Function Documentation

void NewSimulatorEntityPath::AppendRoot int  idx  ) 
 

Append a root entity on position idx.

Parameters:
idx number of position

bool NewSimulatorEntityPath::FromString const char *  str  ) 
 

Encode an entity path to a string.

Parameters:
str char pointer to hold the information
Returns:
return code of successful completion of oh_encode_entitypath()

SaHpiEntityLocationT NewSimulatorEntityPath::GetEntryInstance int  idx  ) 
 

Get entry instance for position idx.

Parameters:
idx number of position
Returns:
entity instance

SaHpiEntityTypeT NewSimulatorEntityPath::GetEntryType int  idx  ) 
 

Return the type of entity on position idx.

Parameters:
idx number of position
Returns:
entity type

void NewSimulatorEntityPath::SetEntry int  idx,
SaHpiEntityTypeT  type,
SaHpiEntityLocationT  instance
 

Set an entry on a fix position.

Parameters:
idx number of position
type entity type
instance instance of entity

void NewSimulatorEntityPath::SetEntryInstance int  idx,
SaHpiEntityLocationT  instance
 

Set entry instance on position idx.

Parameters:
idx number of position
instance instance to be set
Returns:
entity type

void NewSimulatorEntityPath::SetEntryType int  idx,
SaHpiEntityTypeT  type
 

Set entry type on position idx.

Parameters:
idx number of position
type entity type to be set
Returns:
entity type


The documentation for this class was generated from the following files:
Generated on Mon Apr 26 14:39:16 2010 for New Simulator by  doxygen 1.4.4