TherapeuticRegimen

new TherapeuticRegimen(opt_dataopt)

Description:

Generated by JsPbCodeGenerator.

Source:

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

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) IdentifierCase :number

Source:

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

Properties:

Name	Type	Description
`IDENTIFIER_NOT_SET`	number
`EXTERNAL_REFERENCE`	number
`ONTOLOGY_CLASS`	number

Type:

number

(static) RegimenStatus :number

Source:

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

Properties:

Name	Type	Description
`UNKNOWN_STATUS`	number
`STARTED`	number
`COMPLETED`	number
`DISCONTINUED`	number

Type:

number

(static) displayName

Source:

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

(private, static, constant) oneofGroups_

Description:

Oneof group definitions for this message. Each group defines the field numbers belonging to that group. When of these fields' value is set, all other fields in the group are cleared. During deserialization, if multiple fields are encountered for a group, only the last value seen will be kept.

Source:

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

Oneof group definitions for this message. Each group defines the field numbers belonging to that group. When of these fields' value is set, all other fields in the group are cleared. During deserialization, if multiple fields are encountered for a group, only the last value seen will be kept.

Methods

clearEndTime() → (non-null) {proto.org.phenopackets.schema.v2.core.TherapeuticRegimen}

Description:

Clears the message field making it undefined.

Source:

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

Returns:

returns this

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

clearExternalReference() → (non-null) {proto.org.phenopackets.schema.v2.core.TherapeuticRegimen}

Description:

Clears the message field making it undefined.

Source:

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

Returns:

returns this

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

clearOntologyClass() → (non-null) {proto.org.phenopackets.schema.v2.core.TherapeuticRegimen}

Description:

Clears the message field making it undefined.

Source:

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

Returns:

returns this

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

clearStartTime() → (non-null) {proto.org.phenopackets.schema.v2.core.TherapeuticRegimen}

Description:

Clears the message field making it undefined.

Source:

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

Returns:

returns this

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

getEndTime() → (nullable) {proto.org.phenopackets.schema.v2.core.TimeElement}

Description:

optional TimeElement end_time = 4;

Source:

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

Returns:

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

getExternalReference() → (nullable) {proto.org.phenopackets.schema.v2.core.ExternalReference}

Description:

optional ExternalReference external_reference = 1;

Source:

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

Returns:

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

getIdentifierCase() → {proto.org.phenopackets.schema.v2.core.TherapeuticRegimen.IdentifierCase}

Source:

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

Returns:

Type: proto.org.phenopackets.schema.v2.core.TherapeuticRegimen.IdentifierCase

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

Description:

optional OntologyClass ontology_class = 2;

Source:

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

Returns:

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

getRegimenStatus() → (non-null) {proto.org.phenopackets.schema.v2.core.TherapeuticRegimen.RegimenStatus}

Description:

optional RegimenStatus regimen_status = 5;

Source:

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

Returns:

Type: proto.org.phenopackets.schema.v2.core.TherapeuticRegimen.RegimenStatus

getStartTime() → (nullable) {proto.org.phenopackets.schema.v2.core.TimeElement}

Description:

optional TimeElement start_time = 3;

Source:

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

Returns:

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

hasEndTime() → {boolean}

Description:

Returns whether this field is set.

Source:

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

Returns:

Type: boolean

hasExternalReference() → {boolean}

Description:

Returns whether this field is set.

Source:

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

Returns:

Type: boolean

hasOntologyClass() → {boolean}

Description:

Returns whether this field is set.

Source:

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

Returns:

Type: boolean

hasStartTime() → {boolean}

Description:

Returns whether this field is set.

Source:

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

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 1732

Returns:

Type: Uint8Array

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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

Source:

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

Parameters:

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

Returns:

returns this

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

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 1638

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.TherapeuticRegimen}

Description:

Deserializes binary data (in protobuf wire format).

Source:

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

Parameters:

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

Returns:

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

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

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 1688

Parameters:

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

Returns:

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

(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 1746

Parameters:

Name	Type	Description
`message`	proto.org.phenopackets.schema.v2.core.TherapeuticRegimen
`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 1652

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.TherapeuticRegimen	The msg instance to transform.

Returns:

Type: Object