Class: QoS

QoS(historyopt, depthopt, reliabilityopt, durabilityopt, avoidRosNameSpaceConventionsopt)

Class representing middleware quality of service

Constructor

new QoS(historyopt, depthopt, reliabilityopt, durabilityopt, avoidRosNameSpaceConventionsopt)

Create a QoS.
Parameters:
Name Type Attributes Default Description
history HistoryPolicy <optional>
 RMW_QOS_POLICY_HISTORY_SYSTEM_DEFAULT The history value.
depth number <optional>
 0 The depth value.
reliability ReliabilityPolicy <optional>
 RMW_QOS_POLICY_RELIABILITY_SYSTEM_DEFAULT The reliability value.
durability DurabilityPolicy <optional>
 RMW_QOS_POLICY_DURABILITY_SYSTEM_DEFAULT The durability value.
avoidRosNameSpaceConventions boolean <optional>
 false The avoidRosNameSpaceConventions value.
Source:

Methods

get:avoidRosNameSpaceConventions() → {boolean}

Get the avoidRosNameSpaceConventions value.
Source:
Returns:
Type
boolean

get:depth() → {number}

Get the depth value.
Source:
Returns:
Type
number

get:durability() → {number}

Get the durability value.
Source:
Returns:
Type
number

get:history() → {number}

Get the history value.
Source:
Returns:
Type
number

get:reliability() → {number}

Get the reliability value.
Source:
Returns:
Type
number

set:avoidRosNameSpaceConventions(avoidRosNameSpaceConventions) → {undefined}

Set the avoidRosNameSpaceConventions value.
Parameters:
Name Type Description
avoidRosNameSpaceConventions boolean value to be set.
Source:
Returns:
Type
undefined

set:depth(depth) → {undefined}

Set the depth value.
Parameters:
Name Type Description
depth number value to be set.
Source:
Returns:
Type
undefined

set:durability(durability) → {undefined}

Set the durability value.
Parameters:
Name Type Description
durability number value to be set.
Source:
Returns:
Type
undefined

set:history(history) → {undefined}

Set the history value.
Parameters:
Name Type Description
history number value to be set.
Source:
Returns:
Type
undefined

set:reliability(reliability) → {undefined}

Set the reliability value.
Parameters:
Name Type Description
reliability number value to be set.
Source:
Returns:
Type
undefined

static get:DurabilityPolicy() → {DurabilityPolicy}

Get DurabilityPolicy enum.
Source:
Returns:
Type
DurabilityPolicy

static get:HistoryPolicy() → {HistoryPolicy}

Get HistoryPolicy enum.
Source:
Returns:
Type
HistoryPolicy

static get:profileActionStatusDefault() → {string}

Get action status profile.
Source:
Returns:
Type
string

static get:profileDefault() → {string}

Get default profile.
Source:
Returns:
Type
string

static get:profileParameterEvents() → {string}

Get parameter events profile.
Source:
Returns:
Type
string

static get:profileParameters() → {string}

Get parameters profile.
Source:
Returns:
Type
string

static get:profileSensorData() → {string}

Get sensor data profile.
Source:
Returns:
Type
string

static get:profileServicesDefault() → {string}

Get default services profile.
Source:
Returns:
Type
string

static get:profileSystemDefault() → {string}

Get default system profile.
Source:
Returns:
Type
string

static get:ReliabilityPolicy() → {ReliabilityPolicy}

Get ReliabilityPolicy enum.
Source:
Returns:
Type
ReliabilityPolicy