ros2_d

version:

overview

rosidl_parser.definition.structure

struct Member;
Member representation of Structure
AbstractType type;
Type of the member
string name;
Name of the member
Annotation[] annotations;
Annotations
const auto getAnnotationValues(in string name);
Get annotations whose name is name
Parameters:
string name Target annotation name
Returns: A list of annotations
const auto getAnnotationValue(in string name);
Get an annotation whose name is name
Unlike getAnnotationValues collects multiple annotations, this function get only one annotation for the name. If there is no annotation nor more than two annotation, an assertion will be raised.
Parameters:
string name Target annotation name
Returns: An annotation
const bool hasAnnotation(in string name);
Check if one name annotation is available.
Parameters:
string name Target annotation name
Returns: Check result
const bool hasAnnotations(in string name);
Check if (more than one) name annotations are available.
Parameters:
string name Target annotation name
Returns: Check result
const string toString();
Will return "<type> <name> [annotations]".
struct Structure;
Structure representation
The structure must have namespace and be identified as unique name.
NamespacedType namespacedType;
Type of the structure
Member[] members;
Its members
Annotation[] annotations;
Annotations
const auto getAnnotationValues(in string name);
Get annotations whose name is name
Parameters:
string name Target annotation name
Returns: A list of annotations
const auto getAnnotationValue(in string name);
Get an annotation whose name is name
Unlike getAnnotationValues collects multiple annotations, this function get only one annotation for the name. If there is no annotation nor more than two annotation, an assertion will be raised.
Parameters:
string name Target annotation name
Returns: An annotation
const bool hasAnnotation(in string name);
Check if one name annotation is available.
Parameters:
string name Target annotation name
Returns: Check result
const bool hasAnnotations(in string name);
Check if (more than one) name annotations are available.
Parameters:
string name Target annotation name
Returns: Check result
const string toString();
Will return 
<Typename>:
  - <member>
  - ...
struct Constant;
Constant representation
AbstractType type;
Type of the constant
string name;
Name of the constant
string value;
VAlue of the constant
Annotation[] annotations;
Annotations
const auto getAnnotationValues(in string name);
Get annotations whose name is name
Parameters:
string name Target annotation name
Returns: A list of annotations
const auto getAnnotationValue(in string name);
Get an annotation whose name is name
Unlike getAnnotationValues collects multiple annotations, this function get only one annotation for the name. If there is no annotation nor more than two annotation, an assertion will be raised.
Parameters:
string name Target annotation name
Returns: An annotation
const bool hasAnnotation(in string name);
Check if one name annotation is available.
Parameters:
string name Target annotation name
Returns: Check result
const bool hasAnnotations(in string name);
Check if (more than one) name annotations are available.
Parameters:
string name Target annotation name
Returns: Check result
const string toString();
WIll return "<type> <name> <value>".