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

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 ()

Detailed Description

A fault state implementation.

Author:: fracalde

Version:: 1.0

Constructor & Destructor Documentation

cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.FaultStateImpl ( )

constructor

cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.FaultStateImpl	(	String	faultFamily,
		String	faultMember,
		int	faultCode
	)

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 )

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.

References cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.value().

boolean cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.getActivatedByBackup ( )

Implements cern.laser.source.alarmsysteminterface.FaultState.

int cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.getCode ( )

fault code accessor method

Returns:: the fault code

Implements cern.laser.source.alarmsysteminterface.FaultState.

Referenced by alma.alarmsystemdemo.listener.SourcesListener.receive().

String cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.getDescriptor ( )

the fault descriptor accessor method

Returns:: String the fault descriptor

Implements cern.laser.source.alarmsysteminterface.FaultState.

Referenced by alma.alarmsystemdemo.listener.SourcesListener.receive().

String cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.getFamily ( )

fault family accessor method

Returns:: the fault family

Implements cern.laser.source.alarmsysteminterface.FaultState.

Referenced by alma.alarmsystemdemo.listener.SourcesListener.receive().

String cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.getMember ( )

fault member accessor method

Returns:: the fault member

Implements cern.laser.source.alarmsysteminterface.FaultState.

Referenced by alma.alarmsystemdemo.listener.SourcesListener.receive().

boolean cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.getTerminatedByBackup ( )

Implements cern.laser.source.alarmsysteminterface.FaultState.

Properties cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.getUserProperties ( )

return the user properties attached to the fault state

Returns:: Properties the user properties

Implements cern.laser.source.alarmsysteminterface.FaultState.

Referenced by cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.toString().

Timestamp cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.getUserTimestamp ( )

the user timestamp accessor method

Returns:: long the user timestamp

Implements cern.laser.source.alarmsysteminterface.FaultState.

int cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.hashCode ( )

Return the object hash code.

Returns:: The hash code.

References cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.value().

void cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.setActivatedByBackup ( boolean newActivatedByBackup )

Implements cern.laser.source.alarmsysteminterface.FaultState.

void cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.setCode ( int faultCode )

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 )

the fault descriptor accessor method

Parameters:

descriptor

the fault descriptor

Implements cern.laser.source.alarmsysteminterface.FaultState.

Referenced by alma.alarmsystem.core.alarms.LaserCoreFaultState.createFaultState().

void cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.setFamily ( String faultFamily )

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 )

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 )

Implements cern.laser.source.alarmsysteminterface.FaultState.

void cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.setUserProperties ( Properties properties )

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 )

the user timestamp accessor method

Parameters:

timestamp

the user timestamp

Implements cern.laser.source.alarmsysteminterface.FaultState.

Referenced by alma.alarmsystem.core.alarms.LaserCoreFaultState.createFaultState().

String cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.toString ( )

Return a String representation of a FaultState.

Returns:: the String representation

References cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.getUserProperties(), and cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.value().

void cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.validate ( ) throws ASIException

Validate the fault state instance.

Exceptions:

ASIException

if the fault state atributes are null or not valid.

References cern.laser.source.alarmsysteminterface.FaultState.ACTIVE, cern.laser.source.alarmsysteminterface.FaultState.CHANGE, cern.laser.source.alarmsysteminterface.FaultState.INSTANT, and cern.laser.source.alarmsysteminterface.FaultState.TERMINATE.

String cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.value ( ) [protected]

Return a String representation of the object identity.

Returns:: the object identity String representation.

Referenced by cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.equals(), cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.hashCode(), and cern.laser.source.alarmsysteminterface.impl.FaultStateImpl.toString().

The documentation for this class was generated from the following file:

FaultStateImpl.java

All Classes Namespaces Files Functions Variables Enumerations Properties

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation