RTI Connext C# API Version 7.2.0
Rti.Dds.Core.Policy.Profile Class Reference

Configures the way that XML documents containing QoS profiles are loaded by a QosProvider More...

Inherits IEquatable< Profile >.

Public Member Functions

Profile With (Action< ProfileBuilder > build)
 Creates a new Profile with a set of changes specified in an Action More...
 
override int GetHashCode ()
 Gets the hash code More...
 
override bool Equals (object other)
 Compares for equality More...
 
bool Equals (Profile other)
 Compares for equality More...
 

Properties

ImmutableList< string > StringProfile [get]
 Sequence of strings containing a XML document to load. More...
 
ImmutableList< string > UrlProfile [get]
 Sequence of XML URLs containing a set of XML documents to load. More...
 
bool IgnoreUserProfile [get]
 Ignores the file USER_QOS_PROFILES.xml in the current working directory. More...
 
bool IgnoreEnvironmentProfile [get]
 Ignores the value of the NDDS_QOS_PROFILES environment variable. More...
 
bool IgnoreResourceProfile [get]
 Ignores the file NDDS_QOS_PROFILES.xml. More...
 
static Profile Default = CreateDefault() [get]
 Singleton containing the default value of a Profile More...
 

Detailed Description

Configures the way that XML documents containing QoS profiles are loaded by a QosProvider

Member Function Documentation

◆ With()

Profile Rti.Dds.Core.Policy.Profile.With ( Action< ProfileBuilder build)
inline

Creates a new Profile with a set of changes specified in an Action

Parameters
buildAn Action (typically a lambda function) that receives a modifiable object with the current values of this Profile.
Returns
A new Profile with the changes applied by the Action

◆ GetHashCode()

override int Rti.Dds.Core.Policy.Profile.GetHashCode ( )
inline

Gets the hash code

◆ Equals() [1/2]

override bool Rti.Dds.Core.Policy.Profile.Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Rti.Dds.Core.Policy.Profile.Equals ( Profile  other)
inline

Compares for equality

Property Documentation

◆ StringProfile

ImmutableList<string> Rti.Dds.Core.Policy.Profile.StringProfile
get

Sequence of strings containing a XML document to load.

The full documentation is available in the C API: DDS_ProfileQosPolicy_string_profile

◆ UrlProfile

ImmutableList<string> Rti.Dds.Core.Policy.Profile.UrlProfile
get

Sequence of XML URLs containing a set of XML documents to load.

The full documentation is available in the C API: DDS_ProfileQosPolicy_url_profile

◆ IgnoreUserProfile

bool Rti.Dds.Core.Policy.Profile.IgnoreUserProfile
get

Ignores the file USER_QOS_PROFILES.xml in the current working directory.

The full documentation is available in the C API: DDS_ProfileQosPolicy_ignore_user_profile

◆ IgnoreEnvironmentProfile

bool Rti.Dds.Core.Policy.Profile.IgnoreEnvironmentProfile
get

Ignores the value of the NDDS_QOS_PROFILES environment variable.

The full documentation is available in the C API: DDS_ProfileQosPolicy_ignore_environment_profile

◆ IgnoreResourceProfile

bool Rti.Dds.Core.Policy.Profile.IgnoreResourceProfile
get

Ignores the file NDDS_QOS_PROFILES.xml.

The full documentation is available in the C API: DDS_ProfileQosPolicy_ignore_resource_profile

◆ Default

Profile Rti.Dds.Core.Policy.Profile.Default = CreateDefault()
staticget

Singleton containing the default value of a Profile