pssignal.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef PSSIGNAL_H
#define PSSIGNAL_H

#include <unidefs.h>
#include <mechatronics/libmechatronics_exports.h>

#define  PSSIGNAL_CLASS_NAME       "PSSignal"
#define  PSSIGNAL_TYPE_NAME        PSSIGNAL_CLASS_NAME
#define  PSSignalClassName         PSSIGNAL_CLASS_NAME

#define  PSSIGNAL_REV_CLASS_NAME   "PSSignalRevision"
#define  PSSIGNAL_REV_TYPE_NAME    PSSIGNAL_REV_CLASS_NAME
#define  PSSignalRevClassName      PSSIGNAL_REV_CLASS_NAME

#define MESSAGE               "Message"
#define MESSAGE_REV           "Message Revision"

#define SIGNAL_TYPE_NAME           "Signal"
#define SIGNAL_REV_TYPE_NAME       "SignalRevision"

#ifdef __cplusplus
    extern "C"{
#endif

extern MECHATRONICS_API int SIG_create_signal (
    const char*             signal_id,      
    const char*             signal_name,    
    const char*             signal_type,    
    const char*             signal_rev_id,  
    tag_t*                  new_signal,     
    tag_t*                  new_signal_rev  
    );

extern MECHATRONICS_API int SIG_set_signal_pvariable(
    tag_t                   signal_line_tag,    
    tag_t                   pvar_line_tag       
    );

extern MECHATRONICS_API int SIG_unset_signal_pvariable (
    tag_t                   signal_line_tag     
    );

extern MECHATRONICS_API int SIG_ask_signal_pvariable(
    tag_t                   signal_line_tag,    
    tag_t*                  pvar_line_tagptr    
    );

extern MECHATRONICS_API int SIG_unset_associated_systems(
     tag_t primary,                 
     int num_secondaries,            
     tag_t* secondaries,            
     char* role,                    
     logical *has_failures,          
     int *num_failed_lines,          
     tag_t **failed_lines            
     );


extern MECHATRONICS_API int SIG_set_associated_systems(
    tag_t primary,                     
    int    num_secondaries,             
    tag_t* secondaries,                
    char*  role,                       
    logical *has_failures,              
    int     *num_failed_lines,           
    tag_t  **failed_lines               
    );

extern MECHATRONICS_API int SIG_set_associated_system(
    tag_t                   signal_line_tag,    
    tag_t                   system_line_tag,    
    const char*             role,               
    tag_t*                  relation_tagptr     
    );

extern MECHATRONICS_API int SIG_unset_associated_system(
    tag_t                   signal_line_tag,    
    tag_t                   system_line_tag     
    );

extern MECHATRONICS_API int SIG_ask_associated_systems (
    tag_t                   signal_line_tag,            
    int*                    associated_systems_count,   
    tag_t**                 associated_systems_tags     
    );

extern MECHATRONICS_API int SIG_ask_associated_system_role (
    tag_t                   signal_line_tag,        
    tag_t                   associated_sysline_tag, 
    char**                  role                    
    );

extern MECHATRONICS_API int SIG_set_redundant_signal(
    tag_t                   primary_signal_line_tag,    
    tag_t                   redundant_signal_line_tag,  
    tag_t*                  relation_tagptr             
    );

extern MECHATRONICS_API int SIG_unset_redundant_signal(
    tag_t                   primary_signal_line_tag,    
    tag_t                   redundant_signal_line_tag   
    );

extern MECHATRONICS_API int SIG_ask_redundant_signals(
    tag_t                   primary_signal_line_tag,    
    int*                    redundant_signal_count,     
    tag_t**                 redundant_signal_line_tags  
    );

extern MECHATRONICS_API int SIG_set_signal_units (
    tag_t                   signal_tag,     
    tag_t                   uom_tag         
    );

extern MECHATRONICS_API int SIG_ask_signal_units (
    tag_t                   signal_tag,     
    tag_t*                  uom_tagptr      
    );

extern MECHATRONICS_API int SIGREV_set_signal_value (
    tag_t                   signal_rev_tag,     
    double                  signal_value        
    );

extern MECHATRONICS_API int SIGREV_ask_signal_value (
    tag_t                   signal_rev_tag,     
    double*                 signal_value        
    );

extern MECHATRONICS_API int SIGREV_set_signal_characteristics (
    tag_t                   signal_rev_tag,         
    const char*             signal_characteristics  
    );

extern MECHATRONICS_API int SIGREV_ask_signal_characteristics (
    tag_t                   signal_rev_tag,         
    char**                  signal_characteristics  
    );

extern MECHATRONICS_API int SIG_ask_signal_line_value(
     tag_t                  signal_line_tag,    
     double*                signal_value        
     );

extern MECHATRONICS_API int SIG_set_signal_line_value(
     tag_t                  signal_line_tag,    
     double                 signal_value        
     );

extern MECHATRONICS_API int SIG_ask_pvariable_line_value (
    tag_t                   pvar_line_tag,      
    double*                 pvar_line_value     
    );

extern MECHATRONICS_API int SIG_set_pvariable_line_value (
    tag_t                   pvar_line_tag,      
    double                  pvar_line_value     
    );


extern MECHATRONICS_API int SIG_ask_is_message (
    tag_t   lineTag,     
    logical  *verdict    
    );


extern MECHATRONICS_API int SIG_ask_signal_sources  (
    const tag_t linetag,     
    int     *sourcecount,    
    tag_t  **sourcetags      
   );

extern MECHATRONICS_API int SIG_ask_signal_targets  (
    const tag_t linetag,    
    int     *targetcount,   
    tag_t  **targettags     
   );

extern MECHATRONICS_API int SIG_ask_signal_transmitters  (
   const tag_t linetag,       
   int     *txmittercount,    
   tag_t  **txmittertags      
   );

extern MECHATRONICS_API int SIG_ask_device_sources (
    const tag_t linetag,        
    int     *sourcecount,       
       tag_t  **sourcetags      
     );

extern MECHATRONICS_API int SIG_ask_device_targets (
     const tag_t linetag,      
     int     *targetcount,     
     tag_t  **targettags       
      );

extern MECHATRONICS_API int SIG_ask_device_transmitted_signals  (
     const tag_t linetag,      
     int     *txmittedcount,   
     tag_t  **txmittedtags     
    );


extern MECHATRONICS_API int SIG_ask_device_received_signals  (
     const tag_t linetag,        
     int     *receivedcount,     
     tag_t  **receivedtags       
    );

extern MECHATRONICS_API int SIG_ask_signal_pvariables(
    tag_t       signalLineTag,      
    int*        pvariableCount,     
    tag_t**     pvariableLineTags   
    );

extern MECHATRONICS_API int SIG_ask_signals_of_pvariable(
    tag_t       pvariableLineTag,   
    int*        signalCount,        
    tag_t**     signalLineTags      
    );


#ifdef __cplusplus
}
#endif

#include <mechatronics/libmechatronics_undef.h>

#endif