EntityId

class EntityId(*args)

Bases: object

Adapted from the java and c++ implementations of this class.

Methods Summary

equals(id)	returns True if id is EntityId with a value equal to this EntityId, else False.
fromBin(ein)	Create and return an EntityId from an EndianInput instance.
getInstance(stringList)	This mirrors similar functions in the other types.
isNull()	return True if the value is an empty string, else False
toBin(eout)	Write this EntityId to an EndianOutput instance.
validate(candidateId)	check that candidateId is a valid EntityId A valid EntityId must be a string and a match must be found using one of the two regular expressions in this class.

Methods Documentation

equals(id)

returns True if id is EntityId with a value equal to this EntityId, else False.

static fromBin(ein)

Create and return an EntityId from an EndianInput instance.

static getInstance(stringList)

This mirrors similar functions in the other types. This should not be used to construct an EntityId because of the complexity of that object. It is included here in case the translation from java includes such a use. If used it will raise a RuntimeError.

isNull()

return True if the value is an empty string, else False

toBin(eout)

Write this EntityId to an EndianOutput instance.

static validate(candidateId)

check that candidateId is a valid EntityId A valid EntityId must be a string and a match must be found using one of the two regular expressions in this class. If candidateId is valid then this function returns None, otherwise a message is returned that can be used to throw an exception for an invalid EntityId