Skip to main content

EntityUpdateInfo<TEntity>

Namespace: Meshmakers.Octo.Runtime.Contracts

Represents an entity update info.

public class EntityUpdateInfo<TEntity> : IEntityUpdateInfo<TEntity>

Type Parameters

TEntity

Inheritance ObjectEntityUpdateInfo<TEntity>
Implements IEntityUpdateInfo<TEntity>

Properties

RtEntity

public TEntity RtEntity { get; }

Property Value

TEntity

RtId

public Nullable<OctoObjectId> RtId { get; }

Property Value

Nullable<OctoObjectId>

CkTypeId

public CkId<CkTypeId> CkTypeId { get; }

Property Value

CkId<CkTypeId>

ModOption

MOD option.

public EntityModOptions ModOption { get; }

Property Value

EntityModOptions

Methods

GetRtEntityId()

public RtEntityId GetRtEntityId()

Returns

RtEntityId

CreateInsert(CkId<CkTypeId>, TEntity)

Creates a new instance of EntityUpdateInfo<TEntity> for insert.

public static EntityUpdateInfo<TEntity> CreateInsert(CkId<CkTypeId> ckTypeId, TEntity rtEntity)

Parameters

ckTypeId CkId<CkTypeId>
Type identifier of the construction kit

rtEntity TEntity
Runtime entity to insert

Returns

EntityUpdateInfo<TEntity>

CreateInsert(TEntity)

Creates a new instance of EntityUpdateInfo<TEntity> for insert.

public static EntityUpdateInfo<TEntity> CreateInsert(TEntity rtEntity)

Parameters

rtEntity TEntity
Runtime entity to insert

Returns

EntityUpdateInfo<TEntity>

CreateDelete(RtEntityId)

Creates a new instance of EntityUpdateInfo<TEntity> for delete.

public static EntityUpdateInfo<TEntity> CreateDelete(RtEntityId rtEntityId)

Parameters

rtEntityId RtEntityId
Runtime entity identifier for runtime id and construction kit type

Returns

EntityUpdateInfo<TEntity>

CreateUpdate(RtEntityId, TEntity)

Creates a new instance of EntityUpdateInfo<TEntity> for update.

public static EntityUpdateInfo<TEntity> CreateUpdate(RtEntityId rtEntityId, TEntity rtEntity)

Parameters

rtEntityId RtEntityId
Runtime entity identifier for runtime id and construction kit type

rtEntity TEntity
Runtime entity to update

Returns

EntityUpdateInfo<TEntity>

CreateReplace(RtEntityId, TEntity)

Creates a new instance of EntityUpdateInfo<TEntity> for replace.

public static EntityUpdateInfo<TEntity> CreateReplace(RtEntityId rtEntityId, TEntity rtEntity)

Parameters

rtEntityId RtEntityId
Runtime entity identifier for runtime id and construction kit type

rtEntity TEntity
Runtime entity to replace

Returns

EntityUpdateInfo<TEntity>