Receive


[ libohymos | Source | Keywords | Summary | Ancestors | All Members | Descendants ]

Quick Index

DESCRIPTION

Class Summary

template <class T>
class Receive : public Receive_port, public Port_type<T>
{

public:
enum DataConnectionType ;
char* Data_pack_type(void) ;
void Set_data_connection_type(int dct);
T Get_data(time_t t);
Boolean Get_pulse_data(time_t t, T& v);
void Get_data(time_t t, T& v) ;
T Get_data_sum(time_t t1, time_t t2);
T Get_mean_data(time_t t1, time_t t2) ;
Receive<T>* NewPort() ;
Boolean Init(char* p_name, int p_num) ;
Receive(char* p_name, int p_num) ;
Receive(void) ;
~Receive(void) ;
protected:
DataConnectionType data_connection_type;
}; // Receive

Back to the top of Receive


DESCRIPTION

Class Receive< T> receive Data< T>, a sequence of a pair of time and data of type T.

The data connection type of these sequence of data can be selected from

Brokenline
The data are connected with broken line.

Step
The value is taken constant and equal to the current data value from the previous data time till the current time.

Pulse
The value between data times is taken to be zero.

Receive< T> can be connected with Send< T>, Relay< T>, and I_file< T>.

Back to the top of Receive


enum DataConnectionType ;

  enum DataConnectionType { Brokenline, Step, Pulse };

Back to the top of Receive


DataConnectionType data_connection_type;

  DataConnectionType data_connection_type;

Back to the top of Receive


char* Data_pack_type(void) ;

Returns the data_pack_type which expresses the type of data to be received.

  char* Data_pack_type(void)                           
;

Function is currently defined inline.


Back to the top of Receive


void Set_data_connection_type(int dct);

Set data connection type

in dct
- data connection type

        case 0: data_connection_type = Brokenline
        case 1: data_connection_type = Step
        case 2: data_connection_type = Pulse
     

  void Set_data_connection_type(int dct);

Back to the top of Receive


T Get_data(time_t t);

Returns the data value at time t.

  virtual T Get_data(time_t t);

Back to the top of Receive


Boolean Get_pulse_data(time_t t, T& v);

If the datapack at time t exist, returns YES and the data value is stored in "v". Otherwise, returns NO.

  virtual Boolean
    Get_pulse_data(time_t t, T& v);

Back to the top of Receive


void Get_data(time_t t, T& v) ;

Set the data value at time t to reference v

  virtual void Get_data(time_t t, T& v)                     
;

Function is currently defined inline.


Back to the top of Receive


T Get_data_sum(time_t t1, time_t t2);

Returns the integrated value from time t1 till time t2. t1 should be less than or equal to t2.

When data_connection_type is Pulse, the value summed from t1 till t2 will be returned. The pulse at time t1 is not contained in the sum, and the pulse at time t2 is contained in the sum.

  virtual T Get_data_sum(time_t t1, time_t t2);

Back to the top of Receive


T Get_mean_data(time_t t1, time_t t2) ;

  T Get_mean_data(time_t t1, time_t t2)
                                                
;

Function is currently defined inline.


Back to the top of Receive


Receive<T>* NewPort() ;

Returns a new pointer to a new Receive< T> Port

  virtual Receive<T>* NewPort()                             
;

Function is currently defined inline.


Back to the top of Receive


Boolean Init(char* p_name, int p_num) ;

  Boolean Init(char* p_name, int p_num)
                              ;

Function is currently defined inline.


Back to the top of Receive


Receive(char* p_name, int p_num) ;

  Receive(char* p_name, int p_num)
        ;

Function is currently defined inline.


Back to the top of Receive


Receive(void) ;

  Receive(void)
        ;

Function is currently defined inline.


Back to the top of Receive


~Receive(void) ;

  ~Receive(void)   
;

Function is currently defined inline.


Back to the top of Receive


All Members

public:
char* Class_name(void) ;
char* Object_name(void) ;
int Object_number(void) ;
void* Owner(void) ;
Boolean Compare(char* c_name, char* o_name, int o_num);
Boolean Compare(char* o_name, int o_num);
Boolean Compare(Object* obj);
Boolean Set_owner(void* o);
void Cprint(FILE* fp_out, char* head);
void Cprint(FILE* fp_out) ;
void Cprint(char* head ) ;
void Oprint(FILE* fp_out, char* head);
void Oprint(FILE* fp_out) ;
void Oprint(char* head ) ;
void Absname( char* absname );
Boolean Init(char* o_name, int o_num);
char* Data_pack_type(void) ;
Boolean Set_sender(void* s);
Boolean Register_receiver(void* r);
Boolean Switch(void);
Boolean Are_you_ready(void) ;
void Creq(void) ;
void Set_data_pack_array(void) ;
Boolean Can_you_get_data(time_t t_from, time_t t_to) ;
Boolean Can_you_get_data(time_t t) ;
void Get_data_pack_array(void**& dp_array, int& num_of_dp) ;
time_t Oldest_data_time(void) ;
time_t Newest_data_time(void) ;
int Number_of_data_packs(void) ;
Boolean Get_data_pack( void*& former, time_t data_time, void*& later, char flag) ;
Boolean Get_data_pack(void*& former, time_t data_time) ;
Boolean Get_data_pack(time_t data_time, void*& later) ;
time_t Necessary_time_from(void) ;
time_t Necessary_time_to(void) ;
void Reduce_data_pack_stock(void) ;
void Print_connection(FILE* fp_out, char* head);
void Print_connection(FILE*) ;
void Print_connection(char* head ) ;
Port* NewPort(); // pure virtual
Boolean Init(char* p_name, int p_num) ;
Boolean Can_you_get_data(time_t t_fromto) ;
Boolean Get_data_pack(void*& former, time_t data_time, void*& later, char flag ) ;
void Print_connection(FILE* fp_outr, char* head);
enum DataConnectionType ;
void Set_data_connection_type(int dct);
T Get_data(time_t t);
Boolean Get_pulse_data(time_t t, T& v);
void Get_data(time_t t, T& v) ;
T Get_data_sum(time_t t1, time_t t2);
T Get_mean_data(time_t t1, time_t t2) ;
Receive<T>* NewPort() ;
protected:
char* class_name;
char* object_name;
int object_number;
void* owner;
static char* data_pack_type;
void* sender;
DataConnectionType data_connection_type;

Back to the top of Receive


Ancestors

Inheritance chain for Receive:

Back to the top of Receive


Descendants

Class is not inherited by any others.

Back to the top of Receive


Generated from source by the Cocoon utilities on Sun Sep 3 22:52:04 2000 .

Report problems to jkotula@stratasys.com