Treatment - Documentation

Treatment

new Treatment(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 68

Parameters:

Name	Type	Attributes	Description
`opt_data`	Array	<optional>	Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned. If no data is provided, the constructed object will be empty, but still valid.

Extends

jspb.Message

Members

(static) displayName

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 77

(private, static, constant) repeatedFields_

Description:

List of repeated fields within this message type.

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 744

List of repeated fields within this message type.

Methods

addDoseIntervals(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.org.phenopackets.schema.v2.core.DoseInterval}

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 1012

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.org.phenopackets.schema.v2.core.DoseInterval	<optional>
`opt_index`	number	<optional>

Returns:

Type: proto.org.phenopackets.schema.v2.core.DoseInterval

clearAgent() → (non-null) {proto.org.phenopackets.schema.v2.core.Treatment}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 937

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Treatment

clearCumulativeDose() → (non-null) {proto.org.phenopackets.schema.v2.core.Treatment}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 1067

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Treatment

clearDoseIntervalsList() → (non-null) {proto.org.phenopackets.schema.v2.core.Treatment}

Description:

Clears the list making it empty but non-null.

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 1021

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Treatment

clearRouteOfAdministration() → (non-null) {proto.org.phenopackets.schema.v2.core.Treatment}

Description:

Clears the message field making it undefined.

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 974

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Treatment

getAgent() → (nullable) {proto.org.phenopackets.schema.v2.core.OntologyClass}

Description:

optional OntologyClass agent = 1;

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 918

Returns:

Type: proto.org.phenopackets.schema.v2.core.OntologyClass

getCumulativeDose() → (nullable) {proto.org.phenopackets.schema.v2.core.Quantity}

Description:

optional Quantity cumulative_dose = 5;

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 1048

Returns:

Type: proto.org.phenopackets.schema.v2.core.Quantity

getDoseIntervalsList() → (non-null) {Array.<!proto.org.phenopackets.schema.v2.core.DoseInterval>}

Description:

repeated DoseInterval dose_intervals = 3;

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 992

Returns:

Type: Array.<!proto.org.phenopackets.schema.v2.core.DoseInterval>

getDrugType() → (non-null) {proto.org.phenopackets.schema.v2.core.DrugType}

Description:

optional DrugType drug_type = 4;

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 1030

Returns:

Type: proto.org.phenopackets.schema.v2.core.DrugType

getRouteOfAdministration() → (nullable) {proto.org.phenopackets.schema.v2.core.OntologyClass}

Description:

optional OntologyClass route_of_administration = 2;

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 955

Returns:

Type: proto.org.phenopackets.schema.v2.core.OntologyClass

hasAgent() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 946

Returns:

Type: boolean

hasCumulativeDose() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 1076

Returns:

Type: boolean

hasRouteOfAdministration() → {boolean}

Description:

Returns whether this field is set.

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 983

Returns:

Type: boolean

serializeBinary() → (non-null) {Uint8Array}

Description:

Serializes the message to binary data (in protobuf wire format).

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 856

Returns:

Type: Uint8Array

setAgent(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Treatment}

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 928

Parameters:

Name	Type	Description
`value`	proto.org.phenopackets.schema.v2.core.OntologyClass \| undefined

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Treatment

setCumulativeDose(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Treatment}

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 1058

Parameters:

Name	Type	Description
`value`	proto.org.phenopackets.schema.v2.core.Quantity \| undefined

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Treatment

setDoseIntervalsList(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.Treatment}

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 1002

Parameters:

Name	Type	Description
`value`	Array.<!proto.org.phenopackets.schema.v2.core.DoseInterval>

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Treatment

setDrugType(valuenon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.Treatment}

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 1039

Parameters:

Name	Type	Description
`value`	proto.org.phenopackets.schema.v2.core.DrugType

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Treatment

setRouteOfAdministration(value) → (non-null) {proto.org.phenopackets.schema.v2.core.Treatment}

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 965

Parameters:

Name	Type	Description
`value`	proto.org.phenopackets.schema.v2.core.OntologyClass \| undefined

Returns:

returns this

Type: proto.org.phenopackets.schema.v2.core.Treatment

toObject(opt_includeInstanceopt) → (non-null) {Object}

Description:

Creates an object representation of this proto. Field names that are reserved in JavaScript and will be renamed to pb_name. Optional fields that are not set will be set to undefined. To access a reserved field use, foo.pb_, eg, foo.pb_default. For the list of reserved names please see: net/proto2/compiler/js/internal/generator.cc#kKeyword.

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 761

Parameters:

Name	Type	Attributes	Description
`opt_includeInstance`	boolean	<optional>	Deprecated. whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration

Returns:

Type: Object

(static) deserializeBinary(bytes) → (non-null) {proto.org.phenopackets.schema.v2.core.Treatment}

Description:

Deserializes binary data (in protobuf wire format).

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 798

Parameters:

Name	Type	Description
`bytes`	jspb.ByteSource	The bytes to deserialize.

Returns:

Type: proto.org.phenopackets.schema.v2.core.Treatment

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.org.phenopackets.schema.v2.core.Treatment}

Description:

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 812

Parameters:

Name	Type	Description
`msg`	proto.org.phenopackets.schema.v2.core.Treatment	The message object to deserialize into.
`reader`	jspb.BinaryReader	The BinaryReader to use.

Returns:

Type: proto.org.phenopackets.schema.v2.core.Treatment

(static) serializeBinaryToWriter(messagenon-null, writernon-null)

Description:

Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 870

Parameters:

Name	Type	Description
`message`	proto.org.phenopackets.schema.v2.core.Treatment
`writer`	jspb.BinaryWriter

(static) toObject(includeInstance, msgnon-null) → (non-null) {Object}

Description:

Static version of the {@see toObject} method.

Source:

phenopackets/schema/v2/core/medical_action_pb.js, line 775

Parameters:

Name	Type	Description
`includeInstance`	boolean \| undefined	Deprecated. Whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
`msg`	proto.org.phenopackets.schema.v2.core.Treatment	The msg instance to transform.

Returns:

Type: Object