メインページ | ネームスペース一覧 | クラス階層 | 構成 | ファイル一覧 | ネームスペースメンバ | 構成メンバ | ファイルメンバ

クラス RTM::RtcModuleProfile

Profile class of RTComponent Module ------------------------------------------------------------. [詳細]

#include <RtcModuleProfile.h>

すべてのメンバ一覧

Public メソッド

 RtcModuleProfile ()
 RtcModuleProfile (RtcModuleProfSpec *spec)
RTCProfile getProfile ()
bool initSpec (RtcModuleProfSpec *spec)
bool setImplementationId (const char *implementation_id)
 Module name ------------------------------------------------------------.

const char * getImplementationId ()
bool setInstanceId (const char *instance_id)
 Module name ------------------------------------------------------------.

const char * getInstanceId ()
bool setDescription (const char *desc)
 Component description like "Mitsubishi PA10 endeffector velocity control component", "BL autotec NANO sensor", "Sensorble technology PHANToM desktop type", etc... ------------------------------------------------------------.

const char * getDescription ()
bool setVersion (const char *version)
const char * getVersion ()
bool setAuthorName (const char *author_name)
const char * getAuthorName ()
bool setAuthorCompany (const char *author_company)
const char * getAuthorCompany ()
bool setCategory (const char *category)
const char * getCategory ()
bool setComponentType (RTComponentType type)
bool setComponentType (const char *type_str)
RTComponentType getComponentType ()
bool setActivityType (RTCActivityType type)
bool setActivityType (const char *type_str)
RTCActivityType getActivityType ()
bool setMaxInstance (int max)
bool setMaxInstance (const char *max_str)
int getMaxInstance ()
bool setLanguage (const char *langugae)
const char * getLanguage ()
bool setLanguageType (RTCLangType type)
bool setLanguageType (const char *type_str)
RTCLangType getLanguageType ()
bool setIconImage (const char *image)
const char * getIconImage ()
bool appendInPortProfile (const PortProfile port_profile)
PortProfile getInPortProfile (const char *name)
PortProfileList getInPortProfileList ()
bool appendOutPortProfile (const PortProfile port_profile)
PortProfile getOutPortProfile (const char *name)
PortProfileList getOutPortProfileList ()


説明

Profile class of RTComponent Module ------------------------------------------------------------.

------------------------------------------------------------


コンストラクタとデストラクタ

RTM::RtcModuleProfile::RtcModuleProfile  ) 
 

------------------------------------------------------------ A Constructor ------------------------------------------------------------

RTM::RtcModuleProfile::RtcModuleProfile RtcModuleProfSpec spec  ) 
 

------------------------------------------------------------ A Constructor

引数:
spec static table of RtcModuleProfSpec ------------------------------------------------------------


関数

bool RTM::RtcModuleProfile::appendInPortProfile const PortProfile  port_profile  ) 
 

bool RTM::RtcModuleProfile::appendOutPortProfile const PortProfile  port_profile  ) 
 

RTCActivityType RTM::RtcModuleProfile::getActivityType  )  [inline]
 

const char* RTM::RtcModuleProfile::getAuthorCompany  )  [inline]
 

const char* RTM::RtcModuleProfile::getAuthorName  )  [inline]
 

const char* RTM::RtcModuleProfile::getCategory  )  [inline]
 

RTComponentType RTM::RtcModuleProfile::getComponentType  )  [inline]
 

const char* RTM::RtcModuleProfile::getDescription  )  [inline]
 

const char* RTM::RtcModuleProfile::getIconImage  )  [inline]
 

const char* RTM::RtcModuleProfile::getImplementationId  )  [inline]
 

PortProfile RTM::RtcModuleProfile::getInPortProfile const char *  name  ) 
 

PortProfileList RTM::RtcModuleProfile::getInPortProfileList  ) 
 

const char* RTM::RtcModuleProfile::getInstanceId  )  [inline]
 

const char* RTM::RtcModuleProfile::getLanguage  )  [inline]
 

RTCLangType RTM::RtcModuleProfile::getLanguageType  )  [inline]
 

int RTM::RtcModuleProfile::getMaxInstance  )  [inline]
 

PortProfile RTM::RtcModuleProfile::getOutPortProfile const char *  name  ) 
 

PortProfileList RTM::RtcModuleProfile::getOutPortProfileList  ) 
 

RTCProfile RTM::RtcModuleProfile::getProfile  ) 
 

const char* RTM::RtcModuleProfile::getVersion  )  [inline]
 

bool RTM::RtcModuleProfile::initSpec RtcModuleProfSpec spec  ) 
 

------------------------------------------------------------ Initialization from RtcModuleProfSpec table

引数:
spec static table of RtcModuleProfSpec ------------------------------------------------------------

bool RTM::RtcModuleProfile::setActivityType const char *  type_str  ) 
 

bool RTM::RtcModuleProfile::setActivityType RTCActivityType  type  ) 
 

------------------------------------------------------------ Activity type (periodic, sporadic, event_driven...)

Activity type of the component. PERIODIC: Periodic working activity. Period time is is constant. For only realtime OS. ITERATIVE: Iterative working activity. Period time is is constant but deadline will not be unbounded SPORADIC: Sporadic working activity. Activity works depending on outside event or hardware event. EVENT_DRIVEN: Activity works as event driven task. Events will raised from software (other components) ------------------------------------------------------------

bool RTM::RtcModuleProfile::setAuthorCompany const char *  author_company  ) 
 

bool RTM::RtcModuleProfile::setAuthorName const char *  author_name  ) 
 

------------------------------------------------------------ The author of this component

Author include authors' name and authros' company. ------------------------------------------------------------

bool RTM::RtcModuleProfile::setCategory const char *  category  ) 
 

bool RTM::RtcModuleProfile::setComponentType const char *  type_str  ) 
 

bool RTM::RtcModuleProfile::setComponentType RTComponentType  type  ) 
 

bool RTM::RtcModuleProfile::setDescription const char *  desc  ) 
 

Component description like "Mitsubishi PA10 endeffector velocity control component", "BL autotec NANO sensor", "Sensorble technology PHANToM desktop type", etc... ------------------------------------------------------------.

------------------------------------------------------------ Description of component

bool RTM::RtcModuleProfile::setIconImage const char *  image  ) 
 

------------------------------------------------------------ Icon image data

Icon image data, which is used on component CAD, etc.. ------------------------------------------------------------

bool RTM::RtcModuleProfile::setImplementationId const char *  implementation_id  ) 
 

Module name ------------------------------------------------------------.

------------------------------------------------------------ Name of component module

bool RTM::RtcModuleProfile::setInstanceId const char *  instance_id  ) 
 

Module name ------------------------------------------------------------.

------------------------------------------------------------ Name of component module

bool RTM::RtcModuleProfile::setLanguage const char *  langugae  ) 
 

------------------------------------------------------------ Programming language

Programming language which describes this component ------------------------------------------------------------

bool RTM::RtcModuleProfile::setLanguageType const char *  type_str  ) 
 

bool RTM::RtcModuleProfile::setLanguageType RTCLangType  type  ) 
 

------------------------------------------------------------ Programming language type

Programming language type. COMPILED: Language type is compiled like C, C++ etc.. SCRIPT: Language type is script language like Perl, Python, Ruby, etc... ------------------------------------------------------------

bool RTM::RtcModuleProfile::setMaxInstance const char *  max_str  ) 
 

bool RTM::RtcModuleProfile::setMaxInstance int  max  ) 
 

------------------------------------------------------------ Maximum number of instance

Maximum number of instance, which is instantiated on a same manager ------------------------------------------------------------

bool RTM::RtcModuleProfile::setVersion const char *  version  ) 
 

------------------------------------------------------------ Version

Version of this component. ------------------------------------------------------------


このクラスの説明は次のファイルから生成されました:
OpenRTMに対してThu Dec 16 15:29:07 2004に生成されました。 doxygen 1.3.6