com::cosylab::acs::maci::ComponentStatus Class Reference

Collaboration diagram for com::cosylab::acs::maci::ComponentStatus:
Collaboration graph
[legend]

List of all members.

Public Member Functions

String getName ()
String getDescription ()
String toString ()

Static Public Attributes

static final ComponentStatus COMPONENT_ACTIVATED = new ComponentStatus("COMPONENT_ACTIVATED", "Component is activated.")
static final ComponentStatus COMPONENT_DOES_NO_EXIST = new ComponentStatus("COMPONENT_DOES_NO_EXIST", "Component does not exists.")
static final ComponentStatus COMPONENT_NOT_ACTIVATED = new ComponentStatus("COMPONENT_NOT_ACTIVATED", "Component is not activated.")

Protected Member Functions

 ComponentStatus (String name, String description)

Private Attributes

String name
String description

Detailed Description

Status of the Component object. Can be one of: COMPONENT_ACTIVATED, COMPONENT_DOES_NO_EXIST and COMPONENT_NOT_ACTIVATED.

Author:
Matej Sekoranja (matej.sekoranja@cosylab.com)
Version:
@VERSION@

Constructor & Destructor Documentation

com::cosylab::acs::maci::ComponentStatus::ComponentStatus ( String  name,
String  description 
) [inline, protected]

Creates a new status with its name and description. Contructor is protected to deny creation of unsupported statuses

Parameters:
name name of the status, non-null
description description of the status, non-null

Member Function Documentation

String com::cosylab::acs::maci::ComponentStatus::getDescription (  )  [inline]

Returns the description of the status.

Returns:
String description of the status

References description.

String com::cosylab::acs::maci::ComponentStatus::getName (  )  [inline]

Returns the name of the status.

Returns:
String name of the status

References name.

String com::cosylab::acs::maci::ComponentStatus::toString (  )  [inline]

Returns a single-line rendition of this instance into text.

Returns:
internal state of this instance

References description, and name.


Member Data Documentation

final ComponentStatus com::cosylab::acs::maci::ComponentStatus::COMPONENT_DOES_NO_EXIST = new ComponentStatus("COMPONENT_DOES_NO_EXIST", "Component does not exists.") [static]
final ComponentStatus com::cosylab::acs::maci::ComponentStatus::COMPONENT_NOT_ACTIVATED = new ComponentStatus("COMPONENT_NOT_ACTIVATED", "Component is not activated.") [static]

The description of the status.

Referenced by getDescription(), and toString().

The name of the status (e.g. COMPONENT_ACTIVATED).

Referenced by getName(), and toString().


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

Generated by  doxygen 1.6.2