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

cern::laser::source::alarmsysteminterface::impl::FaultStateImpl Class Reference

Inheritance diagram for cern::laser::source::alarmsysteminterface::impl::FaultStateImpl:

Inheritance graph
[legend]
Collaboration diagram for cern::laser::source::alarmsysteminterface::impl::FaultStateImpl:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 FaultStateImpl ()
 FaultStateImpl (String faultFamily, String faultMember, int faultCode)
void setCode (int faultCode)
int getCode ()
void setDescriptor (String descriptor)
String getDescriptor ()
void setFamily (String faultFamily)
String getFamily ()
void setMember (String faultMember)
String getMember ()
void setUserProperties (Properties properties)
Properties getUserProperties ()
void setUserTimestamp (Timestamp timestamp)
Timestamp getUserTimestamp ()
boolean getActivatedByBackup ()
void setActivatedByBackup (boolean newActivatedByBackup)
boolean getTerminatedByBackup ()
void setTerminatedByBackup (boolean newTerminatedByBackup)
boolean equals (Object obj)
int hashCode ()
String toString ()
void validate () throws ASIException

Protected Member Functions

String value ()

Private Attributes

Properties userProperties = new Properties()
String descriptor
String faultFamily = null
String faultMember = null
Timestamp userTimestamp = null
int faultCode
boolean activatedByBackup = false
boolean terminatedByBackup = false

Detailed Description

A fault state implementation.
Author:
fracalde
Version:
1.0


Constructor & Destructor Documentation

cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::FaultStateImpl  )  [inline]
 

constructor

cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::FaultStateImpl String  faultFamily,
String  faultMember,
int  faultCode
[inline]
 

constructor

Parameters:
faultFamily the fault family
faultMember the fault member
faultCode the fault code


Member Function Documentation

boolean cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::equals Object  obj  )  [inline]
 

Check for equality with respect to the fault state triplet ff,fm,fc.

Parameters:
obj the object to check against.
Returns:
true iff the two objects are equal.

boolean cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::getActivatedByBackup  )  [inline]
 

Implements cern::laser::source::alarmsysteminterface::FaultState.

int cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::getCode  )  [inline]
 

fault code accessor method

Returns:
the fault code

Implements cern::laser::source::alarmsysteminterface::FaultState.

String cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::getDescriptor  )  [inline]
 

the fault descriptor accessor method

Returns:
String the fault descriptor

Implements cern::laser::source::alarmsysteminterface::FaultState.

String cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::getFamily  )  [inline]
 

fault family accessor method

Returns:
the fault family

Implements cern::laser::source::alarmsysteminterface::FaultState.

String cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::getMember  )  [inline]
 

fault member accessor method

Returns:
the fault member

Implements cern::laser::source::alarmsysteminterface::FaultState.

boolean cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::getTerminatedByBackup  )  [inline]
 

Implements cern::laser::source::alarmsysteminterface::FaultState.

Properties cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::getUserProperties  )  [inline]
 

return the user properties attached to the fault state

Returns:
Properties the user properties

Implements cern::laser::source::alarmsysteminterface::FaultState.

Timestamp cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::getUserTimestamp  )  [inline]
 

the user timestamp accessor method

Returns:
long the user timestamp

Implements cern::laser::source::alarmsysteminterface::FaultState.

int cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::hashCode  )  [inline]
 

Return the object hash code.

Returns:
The hash code.

void cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::setActivatedByBackup boolean  newActivatedByBackup  )  [inline]
 

Implements cern::laser::source::alarmsysteminterface::FaultState.

void cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::setCode int  faultCode  )  [inline]
 

fault code accessor method

Parameters:
faultCode the fault code

Implements cern::laser::source::alarmsysteminterface::FaultState.

void cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::setDescriptor String  descriptor  )  [inline]
 

the fault descriptor accessor method

Parameters:
descriptor the fault descriptor

Implements cern::laser::source::alarmsysteminterface::FaultState.

void cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::setFamily String  faultFamily  )  [inline]
 

fault family accessor method

Parameters:
faultFamily the fault family

Implements cern::laser::source::alarmsysteminterface::FaultState.

void cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::setMember String  faultMember  )  [inline]
 

fault member accessor method

Parameters:
faultMember the fault member

Implements cern::laser::source::alarmsysteminterface::FaultState.

void cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::setTerminatedByBackup boolean  newTerminatedByBackup  )  [inline]
 

Implements cern::laser::source::alarmsysteminterface::FaultState.

void cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::setUserProperties Properties  properties  )  [inline]
 

set the user properties attached to the fault state

Parameters:
properties the user properties

Implements cern::laser::source::alarmsysteminterface::FaultState.

void cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::setUserTimestamp Timestamp  timestamp  )  [inline]
 

the user timestamp accessor method

Parameters:
timestamp the user timestamp

Implements cern::laser::source::alarmsysteminterface::FaultState.

String cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::toString  )  [inline]
 

Return a String representation of a FaultState.

Returns:
the String representation

void cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::validate  )  throws ASIException [inline]
 

Validate the fault state instance.

Exceptions:
ASIException if the fault state atributes are null or not valid.

String cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::value  )  [inline, protected]
 

Return a String representation of the object identity.

Returns:
the object identity String representation.


Member Data Documentation

boolean cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::activatedByBackup = false [private]
 

String cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::descriptor [private]
 

int cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::faultCode [private]
 

String cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::faultFamily = null [private]
 

String cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::faultMember = null [private]
 

boolean cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::terminatedByBackup = false [private]
 

Properties cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::userProperties = new Properties() [private]
 

Timestamp cern::laser::source::alarmsysteminterface::impl::FaultStateImpl::userTimestamp = null [private]
 


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 03:09:46 2009 for ACS Java API by doxygen 1.3.8