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

NewSimulatorAnnunciator Class Reference

Class for simulating Annunciators. More...

#include <new_sim_annunciator.h>

Inheritance diagram for NewSimulatorAnnunciator:

Inheritance graph
[legend]
Collaboration diagram for NewSimulatorAnnunciator:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 NewSimulatorAnnunciator (NewSimulatorResource *res)
 Constructor.
 NewSimulatorAnnunciator (NewSimulatorResource *res, SaHpiRdrT rdr)
 Full qualified constructor to fill an object with the parsed data.
virtual ~NewSimulatorAnnunciator ()
 Destructor.
virtual unsigned int Num () const
 Return annunciator Number.
SaHpiEntryIdT ValidEntryId ()
 Return a new entryId.
NewSimulatorAnnouncementFindAnnouncement (NewSimulatorAnnouncement *ann)
 Find announcement by announcement pointer.
bool AddAnnouncement (NewSimulatorAnnouncement *ann)
 Add an announcement to the array if it isn't already included in the array.
virtual bool CreateRdr (SaHpiRptEntryT &resource, SaHpiRdrT &rdr)
 A rdr structure is filled with the data.
virtual void SetData (SaHpiAnnunciatorRecT ann_data)
 The annunciator data is copied into the internal record structer.
SaErrorT GetMode (SaHpiAnnunciatorModeT &mode)
 HPI function saHpiAnnunciatorModeGet().
SaErrorT SetMode (SaHpiAnnunciatorModeT mode)
 HPI function saHpiAnnunciatorModeSet().
SaErrorT DeleteAnnouncement (SaHpiEntryIdT &num, SaHpiSeverityT &severity)
 HPI function saHpiAnnunciatorDelete().
SaErrorT AddAnnouncement (SaHpiAnnouncementT &ann)
 HPI function saHpiAnnunciatorAdd().
SaErrorT GetAnnouncement (SaHpiEntryIdT num, SaHpiAnnouncementT &ann)
 HPI function saHpiAnnunciatorGet().
SaErrorT GetNextAnnouncement (SaHpiSeverityT severity, SaHpiBoolT uackOnly, SaHpiAnnouncementT &ann)
 HPI function saHpiAnnunciatorGetNext().
SaErrorT SetAcknowledge (SaHpiEntryIdT num, SaHpiSeverityT severity)
 HPI function saHpiAnnunciatorAcknowledge().
virtual void Dump (NewSimulatorLog &dump) const
 Dump the Annunciator information.

Detailed Description

Class for simulating Annunciators.


Member Function Documentation

SaErrorT NewSimulatorAnnunciator::AddAnnouncement SaHpiAnnouncementT &  ann  ) 
 

HPI function saHpiAnnunciatorAdd().

See also the description of the function inside the specification or header file. Copying the internal reading values (if a read is allowed).

Parameters:
ann announcement to be added
Returns:
HPI return code

bool NewSimulatorAnnunciator::AddAnnouncement NewSimulatorAnnouncement ann  ) 
 

Add an announcement to the array if it isn't already included in the array.

Parameters:
ann pointer to announcement to be added
Returns:
bool if successful

bool NewSimulatorAnnunciator::CreateRdr SaHpiRptEntryT &  resource,
SaHpiRdrT &  rdr
[virtual]
 

A rdr structure is filled with the data.

This method is called by method NewSimulatorRdr::Populate().

Parameters:
resource Address of resource structure
rdr Address of rdr structure
Returns:
true

Reimplemented from NewSimulatorRdr.

SaErrorT NewSimulatorAnnunciator::DeleteAnnouncement SaHpiEntryIdT &  num,
SaHpiSeverityT &  severity
 

HPI function saHpiAnnunciatorDelete().

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

Parameters:
num entryId of announcement to be deleted
severity severity of announcements to be deleted
Returns:
HPI return code

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

Dump the Annunciator information.

Parameters:
dump Address of the log

Implements NewSimulatorRdr.

NewSimulatorAnnouncement * NewSimulatorAnnunciator::FindAnnouncement NewSimulatorAnnouncement ann  ) 
 

Find announcement by announcement pointer.

Parameters:
ann pointer on the announcement to be found
Returns:
return the same pointer if it could be found successfully

SaErrorT NewSimulatorAnnunciator::GetAnnouncement SaHpiEntryIdT  num,
SaHpiAnnouncementT &  ann
 

HPI function saHpiAnnunciatorGet().

See also the description of the function inside the specification or header file. Copying the internal reading values (if a read is allowed).

Parameters:
num announcement id
ann address to Announcement structure where the announcement should be copied to
Returns:
HPI return code

SaErrorT NewSimulatorAnnunciator::GetMode SaHpiAnnunciatorModeT &  mode  ) 
 

HPI function saHpiAnnunciatorModeGet().

See also the description of the function inside the specification or header file. Copying the internal reading values (if a read is allowed).

Parameters:
mode address of return value
Returns:
HPI return code

SaErrorT NewSimulatorAnnunciator::GetNextAnnouncement SaHpiSeverityT  severity,
SaHpiBoolT  uackOnly,
SaHpiAnnouncementT &  ann
 

HPI function saHpiAnnunciatorGetNext().

See also the description of the function inside the specification or header file. Copying the internal reading values (if a read is allowed).

Parameters:
severity of announcement to get
uackOnly flag if only unacknowledge announcement should be returned
ann address to announcement structure where the announcement should be copied to
Returns:
HPI return code

SaErrorT NewSimulatorAnnunciator::SetAcknowledge SaHpiEntryIdT  num,
SaHpiSeverityT  severity
 

HPI function saHpiAnnunciatorAcknowledge().

See also the description of the function inside the specification or header file. Copying the internal reading values (if a read is allowed).

Parameters:
num announcement id to be acknowledged
severity everity of announcements to be acknowledged
Returns:
HPI return code

void NewSimulatorAnnunciator::SetData SaHpiAnnunciatorRecT  ann_data  )  [virtual]
 

The annunciator data is copied into the internal record structer.

Parameters:
ann_data Record to be copied into the internal structure

SaErrorT NewSimulatorAnnunciator::SetMode SaHpiAnnunciatorModeT  mode  ) 
 

HPI function saHpiAnnunciatorModeSet().

See also the description of the function inside the specification or header file. Copying the internal reading values (if a read is allowed).

Parameters:
mode to be set
Returns:
HPI return code


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