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

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

[legend]

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

[legend]

List of all members.

Static Protected Member Functions
static void	spinUp (String clientName, String managerName) throws AcsInformationException, SamplingManagerException, AcsJContainerEx
static void	startSample (SampDetail sDetail) throws CouldntAccessComponentEx, TypeNotSupportedEx, CouldntAccessPropertyEx, SamplingManagerException
static void	stopSample (SampDetail sDetail)
static void	deleteSample (SampDetail sDetail)
static void	tearDown () throws Exception
static void	hashPrint ()
static boolean	componentExists (String componentName)
static boolean	propertyExists (String componentName, String propertyName)
Static Protected Attributes
static AcsInformation	info = null
Static Private Attributes
static Hashtable< SampDetail, PropertySamp >	sampler = new Hashtable<SampDetail,PropertySamp>()

---

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

static 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.

References cl::utfsm::samplingSystemUI::core::AcsInformation::componentExists(), and info.

Referenced by cl::utfsm::example::SampTool::main().

static 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

References sampler, and stopSample().

static void cl::utfsm::samplingSystemUI::core::SamplingManagerUITool::hashPrint

(

)

[inline, static, protected]

References sampler.

static 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.

References info, and cl::utfsm::samplingSystemUI::core::AcsInformation::propertyExists().

Referenced by cl::utfsm::example::SampTool::main().

static void cl::utfsm::samplingSystemUI::core::SamplingManagerUITool::spinUp	(	String	clientName,
		String	managerName
	)			throws AcsInformationException, SamplingManagerException, AcsJContainerEx [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.

Exceptions:

AcsJContainerEx

See also:

AcsInformation

SamplingManager

References cl::utfsm::samplingSystemUI::core::AcsInformation::getInstance(), and info.

Referenced by cl::utfsm::example::SampTool::main(), and cl::utfsm::samplingSystemUI::DataPrinter::startSample().

static void cl::utfsm::samplingSystemUI::core::SamplingManagerUITool::startSample

(

SampDetail

sDetail

)

throws CouldntAccessComponentEx, TypeNotSupportedEx, CouldntAccessPropertyEx, SamplingManagerException [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
	CouldntAccessPropertyEx
	SamplingManagerException

See also:

SampDetail

PropertySamp

References sampler.

Referenced by cl::utfsm::example::SampTool::main().

static 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

References sampler.

Referenced by deleteSample().

static 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

References info, sampler, and cl::utfsm::samplingSystemUI::core::AcsInformation::shutDown().

Referenced by cl::utfsm::samplingSystemUI::DataPrinter::finalize(), cl::utfsm::samplingSystemUI::SampTool::main(), and cl::utfsm::example::SampTool::main().

---

Member Data Documentation

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

Referenced by componentExists(), cl::utfsm::samplingSystemUI::SampTool::getPropsForComponent(), cl::utfsm::samplingSystemUI::SampTool::initializeComponents(), propertyExists(), spinUp(), and tearDown().

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

Referenced by deleteSample(), hashPrint(), startSample(), stopSample(), and tearDown().

---

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

• SamplingManagerUITool.java