acssamp::Samp Interface Reference

import "acssamp.idl";

Inheritance diagram for acssamp::Samp:

[legend]Collaboration diagram for acssamp::Samp:

[legend]List of all members.

Public Member Functions
SampObj	initSampObj (in string name, in string property, in ACS::TimeInterval frequency, in ACS::TimeInterval reportRate) raises (ACSErrTypeCommon::OutOfBoundsEx, ACSErrTypeCommon::MemoryFaultEx, ACSErrTypeCommon::CORBAProblemEx, ACSErrTypeCommon::TypeNotSupportedEx, ACSErrTypeCommon::CouldntAccessPropertyEx, ACSErrTypeCommon::CouldntAccessComponentEx, ACSErrTypeCommon::CouldntCreateObjectEx)

---

Detailed Description

Defines the interface for sampling COBs.

---

Member Function Documentation

SampObj acssamp::Samp::initSampObj (  in string  name, in string  property, in ACS::TimeInterval  frequency, in ACS::TimeInterval  reportRate )  raises (ACSErrTypeCommon::OutOfBoundsEx, ACSErrTypeCommon::MemoryFaultEx, ACSErrTypeCommon::CORBAProblemEx, ACSErrTypeCommon::TypeNotSupportedEx, ACSErrTypeCommon::CouldntAccessPropertyEx, ACSErrTypeCommon::CouldntAccessComponentEx, ACSErrTypeCommon::CouldntCreateObjectEx)

Activate a new CORBA object; it allows to sample a specific property with a user-defined frequency. Collected data are then sent to the Notification channel (ready to be consumed). Parameters: name  component to be sampled (e.g. LAMP1) property  property to be sampled (e.g brightness) frequency  sampling frequency: period between two consecutive sampling (units are 100ns; e.g. 1000000 means 0.1 sec i.e. 10 sample per second) reportRate  number of second the process should buffer before actually sending (notifying) data (units are 100ns; e.g. 10000000 means collect data for 1 second) Returns: SampObj_ptr returns a pointer to the activated sampling object. This pointer must be used for subsequent start/stop/destroy of the actual sampling. * *

---

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

• acssamp.idl

---