Classes | Public Types | Public Member Functions

acssamp::SampObj Interface Reference

import "acssamp.idl";

Inheritance diagram for acssamp::SampObj:
Inheritance graph
[legend]
Collaboration diagram for acssamp::SampObj:
Collaboration graph
[legend]

List of all members.

Classes

struct  SampDataBlock

Public Types

typedef sequence< SampDataBlockSampDataBlockSeq

Public Member Functions

void start ()
void stop ()
void setFrequency (in ACS::TimeInterval sFrequency)
void getFrequency (out ACS::TimeInterval sFrequency)
void setRate (in ACS::TimeInterval rRate)
void getRate (out ACS::TimeInterval rRate)
string getChannelName ()

Member Typedef Documentation


Member Function Documentation

string acssamp::SampObj::getChannelName (  ) 

Returns the channel name to be used with all NC consumers.

Returns:
string current channel name on which data are published.

void acssamp::SampObj::getFrequency ( out ACS::TimeInterval  sFrequency  ) 

Gets the sampling frequency of an already activated sampling object.

Parameters:
sFrequency the current sampling frequency (units are 100ns; e.g. 1000000 means 10 sample per second)
Returns:
void

void acssamp::SampObj::getRate ( out ACS::TimeInterval  rRate  ) 

Gets the report rate of an already activated sampling object.

Parameters:
sFrequency the current report rate report rate (units are 100ns; e.g. 10000000 means collect data for 1 second)
Returns:
void

void acssamp::SampObj::setFrequency ( in ACS::TimeInterval  sFrequency  ) 

These methods are already inherited from the ACS::Subscription interface. Sets the sampling frequency of an already activated sampling object.

Parameters:
sFrequency a new sampling frequency (units are 100ns; e.g. 1000000 means 10 sample per second)
Returns:
void

void acssamp::SampObj::setRate ( in ACS::TimeInterval  rRate  ) 

Sets the report rate of an already activated sampling object.

Parameters:
sFrequency a new report rate (units are 100ns; e.g. 10000000 means collect data for 1 second)
Returns:
void

void acssamp::SampObj::start (  ) 

Once the sampling object is activated, simply starts the sampling.

Returns:
void

void acssamp::SampObj::stop (  ) 

Simply stops an already started sampling.

Returns:
void


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