acsalarm::FaultState Class Reference

#include <FaultState.h>

Collaboration diagram for acsalarm::FaultState:

List of all members.

Public Member Functions
	FaultState ()
	FaultState (const FaultState &)
	FaultState (std::string family, std::string member, int code)
virtual	~FaultState ()
FaultState &	operator= (const FaultState &rhs)
void	setCode (const int faultCode)
int	getCode () const
void	setDescriptor (const std::string &newDescriptor)
std::string	getDescriptor () const
std::string	getFamily () const
std::string	getMember () const
void	setFamily (const std::string &faultFamily)
void	setMember (const std::string &newFaultMember)
virtual std::string	toXML (int amountToIndent=3)
virtual void	setUserProperties (std::auto_ptr< acsalarm::Properties > theProperties)
virtual const acsalarm::Properties &	getUserProperties () const
virtual void	setUserTimestamp (std::auto_ptr< acsalarm::Timestamp > theTimestamp)
virtual const acsalarm::Timestamp &	getUserTimestamp () const
virtual bool	getActivatedByBackup () const
virtual void	setActivatedByBackup (bool newActivatedByBackup)
virtual bool	getTerminatedByBackup () const
virtual void	setTerminatedByBackup (bool newTerminatedByBackup)
Private Attributes
std::string	member
std::string	family
std::string	descriptor
int	code
bool	activatedByBackup
bool	terminatedByBackup
std::auto_ptr < acsalarm::Properties >	userProperties
std::auto_ptr < acsalarm::Timestamp >	userTimestamp

---

Constructor & Destructor Documentation

acsalarm::FaultState::FaultState

(

)

Default constructor, values must be subsequently initialized using setters

acsalarm::FaultState::FaultState

(

const FaultState &

)

Copy constructor.

acsalarm::FaultState::FaultState	(	std::string	family,
		std::string	member,
		int	code
	)

Constructor for initializing a fault state with values

virtual acsalarm::FaultState::~FaultState

(

)

[virtual]

---

Member Function Documentation

virtual bool acsalarm::FaultState::getActivatedByBackup

(

)

const [inline, virtual]

References activatedByBackup.

int acsalarm::FaultState::getCode

(

)

const [inline]

Fault code accessor method.

Returns:

the fault code.

std::string acsalarm::FaultState::getDescriptor

(

)

const [inline]

Fault descriptor accessor method.

Returns:

string the fault descriptor.

References descriptor.

std::string acsalarm::FaultState::getFamily

(

)

const [inline]

Fault family accessor method.

Returns:

the fault family.

std::string acsalarm::FaultState::getMember

(

)

const [inline]

Fault member accessor method.

Returns:

the fault member.

virtual bool acsalarm::FaultState::getTerminatedByBackup

(

)

const [inline, virtual]

References terminatedByBackup.

virtual const acsalarm::Properties& acsalarm::FaultState::getUserProperties

(

)

const [inline, virtual]

User properties accessor method.

Returns:

Properties the user properties.

References userProperties.

virtual const acsalarm::Timestamp& acsalarm::FaultState::getUserTimestamp

(

)

const [inline, virtual]

Timestamp accessor method.

Returns:

long the timestamp.

References userTimestamp.

FaultState& acsalarm::FaultState::operator=

(

const FaultState &

rhs

)

virtual void acsalarm::FaultState::setActivatedByBackup

(

bool

newActivatedByBackup

)

[inline, virtual]

References activatedByBackup.

void acsalarm::FaultState::setCode

(

const int

faultCode

)

[inline]

Fault code accessor method.

Parameters:

faultCode

the fault code.

void acsalarm::FaultState::setDescriptor

(

const std::string &

newDescriptor

)

[inline]

Fault descriptor accessor method.

Parameters:

descriptor

the fault descriptor.

References descriptor.

void acsalarm::FaultState::setFamily

(

const std::string &

faultFamily

)

Fault family accessor method.

Parameters:

faultFamily

the fault family.

void acsalarm::FaultState::setMember

(

const std::string &

newFaultMember

)

Fault member accessor method.

Parameters:

member

the fault member.

virtual void acsalarm::FaultState::setTerminatedByBackup

(

bool

newTerminatedByBackup

)

[inline, virtual]

References terminatedByBackup.

virtual void acsalarm::FaultState::setUserProperties

(

std::auto_ptr< acsalarm::Properties >

theProperties

)

[inline, virtual]

User properties accessor method.

Parameters:

properties

the user properties.

References userProperties.

virtual void acsalarm::FaultState::setUserTimestamp

(

std::auto_ptr< acsalarm::Timestamp >

theTimestamp

)

[inline, virtual]

Timestamp accessor method.

Parameters:

timestamp

the timestamp.

References userTimestamp.

virtual std::string acsalarm::FaultState::toXML

(

int

amountToIndent = 3

)

[virtual]

Returns an XML representation of the fault state. NOTE: this will not be a complete XML document, but just a fragment.

Parameters:

amountToIndent

the amount (in spaces) to indent for readability

For example:

<fault-state family="AlarmSource" member="ALARM_SOURCE_ANTENNA" code="1"> <descriptor>TERMINATE</descriptor> <user-properties> <property name="ASI_PREFIX" value="prefix"> <property name="TEST_PROPERTY" value="TEST_VALUE"> <property name="ASI_SUFFIX" value="suffix"> </user-properties> <user-timestamp seconds="1129902763" microseconds="105000"/> </fault-state>

---

Member Data Documentation

bool acsalarm::FaultState::activatedByBackup [private]

Referenced by getActivatedByBackup(), and setActivatedByBackup().

int acsalarm::FaultState::code [private]

std::string acsalarm::FaultState::descriptor [private]

Referenced by getDescriptor(), and setDescriptor().

std::string acsalarm::FaultState::family [private]

std::string acsalarm::FaultState::member [private]

bool acsalarm::FaultState::terminatedByBackup [private]

Referenced by getTerminatedByBackup(), and setTerminatedByBackup().

std::auto_ptr<acsalarm::Properties> acsalarm::FaultState::userProperties [private]

Referenced by getUserProperties(), and setUserProperties().

std::auto_ptr<acsalarm::Timestamp> acsalarm::FaultState::userTimestamp [private]

Referenced by getUserTimestamp(), and setUserTimestamp().

---

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

• FaultState.h