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

cl::utfsm::samplingSystemUI::core::SamplingManagerUITool Class Reference

Collaboration diagram for cl::utfsm::samplingSystemUI::core::SamplingManagerUITool:

Collaboration graph
[legend]
List of all members.

Static Protected Member Functions

void spinUp (String clientName, String managerName) throws AcsInformationException, SamplingManagerException
void startSample (SampDetail sDetail) throws CouldntAccessComponentEx, TypeNotSupportedEx
void stopSample (SampDetail sDetail)
void deleteSample (SampDetail sDetail)
void tearDown () throws Exception
void hashPrint ()
boolean componentExists (String componentName)
boolean propertyExists (String componentName, String propertyName)

Static Protected Attributes

AcsInformation info = null

Static Private Attributes

Hashtable< SampDetail, PropertySampsampler = new Hashtable<SampDetailPropertySamp>()

Detailed Description

The class is a base class for sampling tools. A tool must extend this class and implement a static main. Usage of the sampling system must only be done through the member provided by this class.


Member Function Documentation

boolean cl::utfsm::samplingSystemUI::core::SamplingManagerUITool::componentExists String  componentName  )  [inline, static, protected]
 

Wraper that checks if a component exists.

Parameters:
componetName the name of the component.

void cl::utfsm::samplingSystemUI::core::SamplingManagerUITool::deleteSample SampDetail  sDetail  )  [inline, static, protected]
 

Stop and delete from the internal structures the sampling identified by a SampDetail.

See also:
SampDetail

void cl::utfsm::samplingSystemUI::core::SamplingManagerUITool::hashPrint  )  [inline, static, protected]
 

boolean cl::utfsm::samplingSystemUI::core::SamplingManagerUITool::propertyExists String  componentName,
String  propertyName
[inline, static, protected]
 

Wraper that checks if a property exists given a component.

Parameters:
componetName the name of the component.
propertyName the name of the property.

void cl::utfsm::samplingSystemUI::core::SamplingManagerUITool::spinUp String  clientName,
String  managerName
throws AcsInformationException, SamplingManagerException [inline, static, protected]
 

Prepares the conection to the ACS infrastructure. This member creates two objects, an AcsInformation and a SamplingManager. This two are the links with the ACS infrastructure.

Parameters:
clientName string tha contains the name with which the tool will register with ACS.
managerName string that contains the name of the sampling manager in the container. This manager is specified in the CDB.
See also:
AcsInformation

SamplingManager

void cl::utfsm::samplingSystemUI::core::SamplingManagerUITool::startSample SampDetail  sDetail  )  throws CouldntAccessComponentEx, TypeNotSupportedEx [inline, static, protected]
 

Start the sampling of a property. This member will start a PropertySamp object, which will run in a separeted Thread.

Parameters:
sDetail a SampDetail object that contains the specification for the sampling.
Exceptions:
CouldntAccessComponentEx 
TypeNotSupportedEx 
See also:
SampDetail

PropertySamp

void cl::utfsm::samplingSystemUI::core::SamplingManagerUITool::stopSample SampDetail  sDetail  )  [inline, static, protected]
 

Stop the sampling of a property identified by a SampDetail.

See also:
SampDetail

void cl::utfsm::samplingSystemUI::core::SamplingManagerUITool::tearDown  )  throws Exception [inline, static, protected]
 

Shutdown all the sampling operation. Stop every sampling, and disconnects from the ACS manager.

See also:
AcsInformation


Member Data Documentation

AcsInformation cl::utfsm::samplingSystemUI::core::SamplingManagerUITool::info = null [static, protected]
 

Hashtable<SampDetail,PropertySamp> cl::utfsm::samplingSystemUI::core::SamplingManagerUITool::sampler = new Hashtable<SampDetailPropertySamp>() [static, private]
 


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