RTI Connext Java API  Version 6.0.0
 All Classes Namespaces Functions Variables Groups Pages
ProfileQosPolicy Class Reference

Configures the way that XML documents containing QoS profiles are loaded by RTI Connext. More...

Inheritance diagram for ProfileQosPolicy:
QosPolicy

Public Attributes

final StringSeq string_profile
 Sequence of strings containing a XML document to load.
 
final StringSeq url_profile
 Sequence of URL groups containing a set of XML documents to load.
 
boolean ignore_user_profile
 Ignores the file USER_QOS_PROFILES.xml in the current working directory.
 
boolean ignore_environment_profile
 Ignores the value of the NDDS_QOS_PROFILES environment variable.
 
boolean ignore_resource_profile
 Ignores the file NDDS_QOS_PROFILES.xml.
 
- Public Attributes inherited from QosPolicy
final QosPolicyId_t id
 The ID of this QoS policy.
 
final String policy_name
 The name of this QoS policy.
 

Additional Inherited Members

- Public Member Functions inherited from Struct
abstract boolean equals (Object obj)
 
abstract int hashCode ()
 
String toString ()
 
- Protected Member Functions inherited from Struct
 Struct ()
 
abstract void pull_from_nativeI (long native_status)
 
abstract void push_to_nativeI (long native_status)
 

Detailed Description

Configures the way that XML documents containing QoS profiles are loaded by RTI Connext.

All QoS values for Entities can be configured in QoS profiles defined in XML documents. XML documents can be passed to RTI Connext in string form or, more likely, through files found on a file system.

There are also default locations where DomainParticipants will look for files to load QoS profiles. These include the current working directory from where an application is started, a file in the distribution directory for RTI Connext, and the locations specified by an environment variable.

You may disable any or all of these default locations using the Profile QoS policy.

Entity:
com.rti.dds.domain.DomainParticipantFactory
Properties:
RxO = NO
Changeable = Changeable

Member Data Documentation

final StringSeq string_profile

Sequence of strings containing a XML document to load.

The concatenation of the strings in this sequence must be a valid XML document according to the XML QoS profile schema.

[default] Empty sequence (zero-length).

final StringSeq url_profile

Sequence of URL groups containing a set of XML documents to load.

Only one of the elements of each group will be loaded by RTI Connext, starting from the left.

[default] Empty sequence (zero-length).

boolean ignore_user_profile

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

When this field is set to com.rti.dds.infrastructure.true, the QoS profiles contained in the file USER_QOS_PROFILES.xml in the current working directory will be ignored.

[default] com.rti.dds.infrastructure.false

boolean ignore_environment_profile

Ignores the value of the NDDS_QOS_PROFILES environment variable.

When this field is set to com.rti.dds.infrastructure.true, the value of the environment variable NDDS_QOS_PROFILES will be ignored.

[default] com.rti.dds.infrastructure.false

boolean ignore_resource_profile

Ignores the file NDDS_QOS_PROFILES.xml.

When this field is set to com.rti.dds.infrastructure.true, the QoS profiles contained in the file NDDS_QOS_PROFILES.xml in $NDDSHOME/resource/xml will be ignored.

[default] com.rti.dds.infrastructure.false


RTI Connext Java API Version 6.0.0 Copyright © Sun Mar 3 2019 Real-Time Innovations, Inc