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

NewSimulatorEventLog Class Reference

Class for wrapping event log functions. More...

#include <new_sim_event_log.h>

Inheritance diagram for NewSimulatorEventLog:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 NewSimulatorEventLog ()
 Constructor.
virtual ~NewSimulatorEventLog ()
 Destructor.
SaErrorT IfELGetInfo (oh_handler_state *hstate, SaHpiEventLogInfoT *info)
 HPI function saHpiEventLogInfoGet().
SaErrorT IfELSetState (oh_handler_state *hstate, SaHpiBoolT state)
 HPI function saHpiEventLogStateSet().
SaErrorT IfELGetState (oh_handler_state *hstate, SaHpiBoolT *state)
 HPI function saHpiEventLogStateGet().
SaErrorT IfELSetTime (oh_handler_state *hstate, SaHpiTimeT time)
 HPI function saHpiEventLogTimeSet().
SaErrorT IfELAddEntry (oh_handler_state *hstate, const SaHpiEventT *event)
 HPI function saHpiEventLogEntryAdd().
SaErrorT IfELGetEntry (oh_handler_state *hstate, SaHpiEventLogEntryIdT current, SaHpiEventLogEntryIdT *prev, SaHpiEventLogEntryIdT *next, SaHpiEventLogEntryT *entry, SaHpiRdrT *rdr, SaHpiRptEntryT *rptentry)
 HPI function saHpiEventLogEntryGet().
SaErrorT IfELClear (oh_handler_state *hstate)
 HPI function saHpiEventLogClear().
SaErrorT IfELOverflow (oh_handler_state *hstate)
 HPI function saHpiEventLogOverflowReset().
SaErrorT IfELGetCaps (oh_handler_state *hstate, SaHpiEventLogCapabilitiesT *caps)
 HPI function saHpiEventLogCapabilitiesGet().

Detailed Description

Class for wrapping event log functions.


Member Function Documentation

SaErrorT NewSimulatorEventLog::IfELAddEntry oh_handler_state *  hstate,
const SaHpiEventT *  event
 

HPI function saHpiEventLogEntryAdd().

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

Parameters:
hstate pointer on the handler state struct
event pointer to event data to write to the Event Log
Returns:
HPI return code

SaErrorT NewSimulatorEventLog::IfELClear oh_handler_state *  hstate  ) 
 

HPI function saHpiEventLogClear().

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

Parameters:
hstate pointer on the handler state struct
Returns:
HPI return code

SaErrorT NewSimulatorEventLog::IfELGetCaps oh_handler_state *  hstate,
SaHpiEventLogCapabilitiesT *  caps
 

HPI function saHpiEventLogCapabilitiesGet().

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

Parameters:
hstate pointer on the handler state struct
caps Pointer to store the Event Log Capabilities value
Returns:
HPI return code

SaErrorT NewSimulatorEventLog::IfELGetEntry oh_handler_state *  hstate,
SaHpiEventLogEntryIdT  current,
SaHpiEventLogEntryIdT *  prev,
SaHpiEventLogEntryIdT *  next,
SaHpiEventLogEntryT *  entry,
SaHpiRdrT *  rdr,
SaHpiRptEntryT *  rptentry
 

HPI function saHpiEventLogEntryGet().

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

Parameters:
hstate pointer on the handler state struct
current Identifier of event log entry to retrieve
prev Event Log entry identifier for the previous entry
next Event Log entry identifier for the next entry
entry Pointer to retrieved Event Log entry
rdr Pointer to structure to receive resource data record
rptentry Pointer to structure to receive RPT entry
Returns:
HPI return code

SaErrorT NewSimulatorEventLog::IfELGetInfo oh_handler_state *  hstate,
SaHpiEventLogInfoT *  info
 

HPI function saHpiEventLogInfoGet().

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

Parameters:
hstate pointer on the handler state struct
info pointer to the returned Event Log information
Returns:
HPI return code

SaErrorT NewSimulatorEventLog::IfELGetState oh_handler_state *  hstate,
SaHpiBoolT *  state
 

HPI function saHpiEventLogStateGet().

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

Parameters:
hstate pointer on the handler state struct
state pointer to the current event log enable state
Returns:
HPI return code

SaErrorT NewSimulatorEventLog::IfELOverflow oh_handler_state *  hstate  ) 
 

HPI function saHpiEventLogOverflowReset().

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

Parameters:
hstate pointer on the handler state struct
Returns:
HPI return code

SaErrorT NewSimulatorEventLog::IfELSetState oh_handler_state *  hstate,
SaHpiBoolT  state
 

HPI function saHpiEventLogStateSet().

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

Parameters:
hstate pointer on the handler state struct
state event Log state to be set
Returns:
HPI return code

SaErrorT NewSimulatorEventLog::IfELSetTime oh_handler_state *  hstate,
SaHpiTimeT  time
 

HPI function saHpiEventLogTimeSet().

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

Parameters:
hstate pointer on the handler state struct
time time to which the Event Log clock should be set
Returns:
HPI return code


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