VitalStatus

VitalStatus

new VitalStatus(opt_dataopt)

Description:
  • Generated by JsPbCodeGenerator.
Source:
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) Status :number

Source:
Properties:
Name Type Description
UNKNOWN_STATUS number
ALIVE number
DECEASED number
Type:
  • number

(static) displayName

Source:

Methods

clearCauseOfDeath() → (non-null) {proto.org.phenopackets.schema.v2.core.VitalStatus}

Description:
  • Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.org.phenopackets.schema.v2.core.VitalStatus

clearTimeOfDeath() → (non-null) {proto.org.phenopackets.schema.v2.core.VitalStatus}

Description:
  • Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.org.phenopackets.schema.v2.core.VitalStatus

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

Description:
  • optional OntologyClass cause_of_death = 3;
Source:
Returns:
Type
proto.org.phenopackets.schema.v2.core.OntologyClass

getStatus() → (non-null) {proto.org.phenopackets.schema.v2.core.VitalStatus.Status}

Description:
  • optional Status status = 1;
Source:
Returns:
Type
proto.org.phenopackets.schema.v2.core.VitalStatus.Status

getSurvivalTimeInDays() → {number}

Description:
  • optional uint32 survival_time_in_days = 4;
Source:
Returns:
Type
number

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

Description:
  • optional TimeElement time_of_death = 2;
Source:
Returns:
Type
proto.org.phenopackets.schema.v2.core.TimeElement

hasCauseOfDeath() → {boolean}

Description:
  • Returns whether this field is set.
Source:
Returns:
Type
boolean

hasTimeOfDeath() → {boolean}

Description:
  • Returns whether this field is set.
Source:
Returns:
Type
boolean

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

Description:
  • Serializes the message to binary data (in protobuf wire format).
Source:
Returns:
Type
Uint8Array

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

Source:
Parameters:
Name Type Description
value proto.org.phenopackets.schema.v2.core.OntologyClass | undefined
Returns:
returns this
Type
proto.org.phenopackets.schema.v2.core.VitalStatus

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

Source:
Parameters:
Name Type Description
value proto.org.phenopackets.schema.v2.core.VitalStatus.Status
Returns:
returns this
Type
proto.org.phenopackets.schema.v2.core.VitalStatus

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

Source:
Parameters:
Name Type Description
value number
Returns:
returns this
Type
proto.org.phenopackets.schema.v2.core.VitalStatus

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

Source:
Parameters:
Name Type Description
value proto.org.phenopackets.schema.v2.core.TimeElement | undefined
Returns:
returns this
Type
proto.org.phenopackets.schema.v2.core.VitalStatus

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:
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.VitalStatus}

Description:
  • Deserializes binary data (in protobuf wire format).
Source:
Parameters:
Name Type Description
bytes jspb.ByteSource The bytes to deserialize.
Returns:
Type
proto.org.phenopackets.schema.v2.core.VitalStatus

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

Description:
  • Deserializes binary data (in protobuf wire format) from the given reader into the given message object.
Source:
Parameters:
Name Type Description
msg proto.org.phenopackets.schema.v2.core.VitalStatus The message object to deserialize into.
reader jspb.BinaryReader The BinaryReader to use.
Returns:
Type
proto.org.phenopackets.schema.v2.core.VitalStatus

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

Description:
  • Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.
Source:
Parameters:
Name Type Description
message proto.org.phenopackets.schema.v2.core.VitalStatus
writer jspb.BinaryWriter

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

Description:
  • Static version of the {@see toObject} method.
Source:
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.VitalStatus The msg instance to transform.
Returns:
Type
Object