RTI Connext C# API Version 7.7.0
Rti.Types.Dynamic.Annotations Class Reference

Sets of annotated properties that can be applied to types and their members. More...

Inherits IEquatable< Annotations >.

Public Member Functions

 Annotations ()
 Creates a new Annotations with no values. More...
 
 Annotations (TypeKind valueKind, AnnotationParameterValue defaultValue, AnnotationParameterValue minValue, AnnotationParameterValue maxValue, String unit)
 Creates a new Annotations with the provided values. More...
 
override bool Equals (object other)
 Compares for equality More...
 
bool Equals (Annotations other)
 Compares for equality More...
 
override int GetHashCode ()
 A simple hash code function. More...
 

Properties

TypeKind ValueKind [get]
 The type of the annotation parameter values. More...
 
AnnotationParameterValue Default [get]
 The value of the <B>[default]</B> annotation, if specified. More...
 
AnnotationParameterValue Max [get]
 The value of the @max annotation, if specified. More...
 
AnnotationParameterValue Min [get]
 The value of the @min annotation, if specified. More...
 
String Unit [get]
 The value of the @unit annotation, if specified. More...
 

Detailed Description

Sets of annotated properties that can be applied to types and their members.

Constructor & Destructor Documentation

◆ Annotations() [1/2]

Rti.Types.Dynamic.Annotations.Annotations ( )
inline

Creates a new Annotations with no values.

◆ Annotations() [2/2]

Rti.Types.Dynamic.Annotations.Annotations ( TypeKind  valueKind,
AnnotationParameterValue  defaultValue,
AnnotationParameterValue  minValue,
AnnotationParameterValue  maxValue,
String  unit 
)
inline

Creates a new Annotations with the provided values.

Member Function Documentation

◆ Equals() [1/2]

override bool Rti.Types.Dynamic.Annotations.Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Rti.Types.Dynamic.Annotations.Equals ( Annotations  other)
inline

Compares for equality

◆ GetHashCode()

override int Rti.Types.Dynamic.Annotations.GetHashCode ( )
inline

A simple hash code function.

Property Documentation

◆ ValueKind

TypeKind Rti.Types.Dynamic.Annotations.ValueKind
get

The type of the annotation parameter values.

◆ Default

AnnotationParameterValue Rti.Types.Dynamic.Annotations.Default
get

The value of the <B>[default]</B> annotation, if specified.

◆ Max

AnnotationParameterValue Rti.Types.Dynamic.Annotations.Max
get

The value of the @max annotation, if specified.

◆ Min

AnnotationParameterValue Rti.Types.Dynamic.Annotations.Min
get

The value of the @min annotation, if specified.

◆ Unit

String Rti.Types.Dynamic.Annotations.Unit
get

The value of the @unit annotation, if specified.