OpenRTM-aist IDL  1.2
Public Attributes | List of all members
RTC::ComponentProfile Struct Reference

ComponentProfile. More...

import"RTC.idl";

Collaboration diagram for RTC::ComponentProfile:
Collaboration graph
[legend]

Public Attributes

string instance_name
 instance_name More...
 
string type_name
 type_name More...
 
string description
 description More...
 
string version
 version More...
 
string vendor
 vendor More...
 
string category
 category More...
 
PortProfileList port_profiles
 port_profiles More...
 
RTObject parent
 parent More...
 
NVList properties
 properties More...
 

Detailed Description

ComponentProfile.

Description

ComponentProfile represents the static state of an RTC that is referred to here as the "target" RTC.

Member Data Documentation

string RTC::ComponentProfile::category

category

Description

This attribute contains the name of a "category" or group to which the target RTC belongs.

string RTC::ComponentProfile::description

description

Description

This attribute shall briefly describe the target RTC for the benefit of a human operator.

string RTC::ComponentProfile::instance_name

instance_name

Description

This attribute shall contain the name of the target RTC instance.

Semantics

The instance_name should be unique among RTC instances contained within the same containing component.

RTObject RTC::ComponentProfile::parent

parent

Description

This attribute contains a reference to the RTC that contains the target RTC instance. If the target RTC instance is not owned by any other RTC, this field stores a nil reference.

PortProfileList RTC::ComponentProfile::port_profiles

port_profiles

Description

This attribute contains a list of PortProfiles that describe the ports of the target RTC.

Semantics

There shall be a one-to-one correspondence between the members of this list and the ports of the target RTC.

NVList RTC::ComponentProfile::properties

properties

Description

This attribute contains additional properties of the target RTC.

Semantics

This attribute provides implementations the opportunity to describe additional characteristics of a particular RTC that are otherwise outside of the scope of this specification.

string RTC::ComponentProfile::type_name

type_name

Description

This attribute shall contain the name of the target RTC class.

Semantics

Each RTC class must have a name that is unique within an application.

string RTC::ComponentProfile::vendor

vendor

Description

The name of the individual or organization that produced the target RTC class.

string RTC::ComponentProfile::version

version

Description

This attribute shall contain the version number of the target RTC class.

Semantics

The format of the version number is outside of the scope of this specification.


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