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

NewSimulatorInventoryArea Class Reference

Class for simulating InventoryArea. More...

#include <new_sim_inventory_data.h>

Collaboration diagram for NewSimulatorInventoryArea:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 NewSimulatorInventoryArea ()
 Constructor.
 NewSimulatorInventoryArea (SaHpiIdrAreaHeaderT area)
 Full qualified constructor to fill an object with the parsed data.
virtual ~NewSimulatorInventoryArea ()
 Destructor.
virtual SaHpiEntryIdT Num () const
 Return Inventory AreaId.
virtual SaHpiIdrAreaTypeT Type () const
 Return Area Type.
SaHpiEntryIdT ValidFieldId ()
 Return a new entryId.
bool IsReadOnly ()
 Return the ReadOnly flag.
SaHpiIdrAreaHeaderT & AreaHeader ()
 Return the complete header information.
NewSimulatorInventoryFieldFindInventoryField (NewSimulatorInventoryField *field)
 Find field by field pointer.
bool AddInventoryField (NewSimulatorInventoryField *field)
 Add a inventory field to the array if it isn't already included in the array.
bool IncludesReadOnlyField ()
 Check the Inventory fields if one field is set to ReadOnly.
void DeleteFields ()
 Delete all fields from the fields array.
bool SetData (SaHpiIdrAreaHeaderT aheader)
 Set area header information The field NumAreas is filled with a internal values and will not be overwritten.
SaErrorT GetField (SaHpiIdrFieldTypeT fieldType, SaHpiEntryIdT fieldId, SaHpiEntryIdT &nextId, SaHpiIdrFieldT &field)
 HPI function saHpiIdrFieldGet().
SaErrorT AddField (SaHpiIdrFieldT &field)
 HPI function saHpiIdrFieldAdd().
SaErrorT AddFieldById (SaHpiIdrFieldT &field)
 HPI function saHpiIdrFieldAddById().
SaErrorT SetField (SaHpiIdrFieldT field)
 HPI function saHpiIdrFieldSet().
SaErrorT DeleteField (SaHpiEntryIdT fieldId)
 HPI function saHpiIdrFieldDelete().
virtual void Dump (NewSimulatorLog &dump) const
 Dump the Inventory Area information.

Detailed Description

Class for simulating InventoryArea.


Member Function Documentation

SaErrorT NewSimulatorInventoryArea::AddField SaHpiIdrFieldT &  field  ) 
 

HPI function saHpiIdrFieldAdd().

See also the description of the function inside the specification or header file.

Parameters:
field address of Inventory Data Field, which contains the new field information to add
Returns:
HPI return code

SaErrorT NewSimulatorInventoryArea::AddFieldById SaHpiIdrFieldT &  field  ) 
 

HPI function saHpiIdrFieldAddById().

See also the description of the function inside the specification or header file.

Parameters:
field address of Inventory Data Field, which contains the new field information to add
Returns:
HPI return code

bool NewSimulatorInventoryArea::AddInventoryField NewSimulatorInventoryField field  ) 
 

Add a inventory field to the array if it isn't already included in the array.

Parameters:
field pointer to field to be added
Returns:
bool if successful

SaErrorT NewSimulatorInventoryArea::DeleteField SaHpiEntryIdT  fieldId  ) 
 

HPI function saHpiIdrFieldDelete().

See also the description of the function inside the specification or header file.

Parameters:
fieldId Identifier of Field to delete from the IDA
Returns:
HPI return code

void NewSimulatorInventoryArea::Dump NewSimulatorLog dump  )  const [virtual]
 

Dump the Inventory Area information.

Parameters:
dump Address of the log

NewSimulatorInventoryField * NewSimulatorInventoryArea::FindInventoryField NewSimulatorInventoryField field  ) 
 

Find field by field pointer.

Parameters:
field pointer on the inventory field to be found
Returns:
return the same pointer if it could be found

SaErrorT NewSimulatorInventoryArea::GetField SaHpiIdrFieldTypeT  fieldType,
SaHpiEntryIdT  fieldId,
SaHpiEntryIdT &  nextId,
SaHpiIdrFieldT &  field
 

HPI function saHpiIdrFieldGet().

See also the description of the function inside the specification or header file.

Parameters:
fieldType Type of Inventory Data Field
fieldId Identifier of Field to retrieve
nextId address to store the FieldId of next field
field address into which the field information is placed
Returns:
HPI return code

bool NewSimulatorInventoryArea::IncludesReadOnlyField  ) 
 

Check the Inventory fields if one field is set to ReadOnly.

Returns:
bool if one field is set to read only

bool NewSimulatorInventoryArea::SetData SaHpiIdrAreaHeaderT  aheader  ) 
 

Set area header information The field NumAreas is filled with a internal values and will not be overwritten.

Parameters:
aheader record with AreaHeader data
Returns:
true

SaErrorT NewSimulatorInventoryArea::SetField SaHpiIdrFieldT  field  ) 
 

HPI function saHpiIdrFieldSet().

See also the description of the function inside the specification or header file.

Parameters:
field field to set in the IDA
Returns:
HPI return code


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