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

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

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

References value().

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

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

References activatedByBackup.

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

fault code accessor method

Returns:: the fault code

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

References faultCode.

Referenced by alma::lasersource::test::SendTest::isValidFSMessage(), alma::alarmsystemdemo::listener::SourcesListener::receive(), and alma::demo::test::DemoTest::receive().

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.

References descriptor.

Referenced by alma::alarmsystemdemo::listener::SourcesListener::receive(), and alma::demo::test::DemoTest::receive().

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

fault family accessor method

Returns:: the fault family

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

References faultFamily.

Referenced by alma::lasersource::test::SendTest::isValidFSMessage(), alma::alarmsystemdemo::listener::SourcesListener::receive(), and alma::demo::test::DemoTest::receive().

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

fault member accessor method

Returns:: the fault member

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

References faultMember.

Referenced by alma::lasersource::test::SendTest::isValidFSMessage(), alma::alarmsystemdemo::listener::SourcesListener::receive(), and alma::demo::test::DemoTest::receive().

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

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

References terminatedByBackup.

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.

References userProperties.

Referenced by toString().

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.

References userTimestamp.

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

Return the object hash code.

Returns:: The hash code.

References value().

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

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

References activatedByBackup.

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.

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

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.

References terminatedByBackup.

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.

References userProperties.

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.

References userTimestamp.

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

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

Return a String representation of a FaultState.

Returns:: the String representation

References descriptor, faultCode, faultFamily, faultMember, getUserProperties(), userTimestamp, and value().

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.

References cern::laser::source::alarmsysteminterface::FaultState::ACTIVE, cern::laser::source::alarmsysteminterface::FaultState::CHANGE, descriptor, faultFamily, faultMember, cern::laser::source::alarmsysteminterface::FaultState::INSTANT, cern::laser::source::alarmsysteminterface::FaultState::TERMINATE, userProperties, and userTimestamp.

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

Return a String representation of the object identity.

Returns:: the object identity String representation.

References faultCode, faultFamily, and faultMember.

Referenced by equals(), hashCode(), and toString().

Member Data Documentation

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

Referenced by getActivatedByBackup(), and setActivatedByBackup().

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

Referenced by getDescriptor(), toString(), and validate().

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

Referenced by getCode(), toString(), and value().

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

Referenced by getFamily(), toString(), validate(), and value().

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

Referenced by getMember(), toString(), validate(), and value().

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

Referenced by getTerminatedByBackup(), and setTerminatedByBackup().

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

Referenced by getUserProperties(), setUserProperties(), and validate().

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

Referenced by getUserTimestamp(), setUserTimestamp(), toString(), and validate().

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

FaultStateImpl.java

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

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation