CatapultServer  v0.5.0.1 (Elephant)
catapult::state::LockInfo Struct Reference

A lock info. More...

Inheritance diagram for catapult::state::LockInfo:
Collaboration diagram for catapult::state::LockInfo:

Public Member Functions

constexpr bool isActive (catapult::Height height) const
 Returns true if lock info is active at height. More...
 

Public Attributes

Key Account
 Account. More...
 
catapult::MosaicId MosaicId
 Mosaic id. More...
 
catapult::Amount Amount
 Amount. More...
 
catapult::Height Height
 Height at which the lock expires. More...
 
LockStatus Status
 Flag indicating whether or not the lock was already used. More...
 

Protected Member Functions

 LockInfo ()
 Creates a default lock info. More...
 
 LockInfo (const Key &account, catapult::MosaicId mosaicId, catapult::Amount amount, catapult::Height height)
 Creates a lock info around account, mosaicId, amount and height. More...
 

Detailed Description

A lock info.

Constructor & Destructor Documentation

◆ LockInfo() [1/2]

catapult::state::LockInfo::LockInfo ( )
inlineprotected

Creates a default lock info.

◆ LockInfo() [2/2]

catapult::state::LockInfo::LockInfo ( const Key account,
catapult::MosaicId  mosaicId,
catapult::Amount  amount,
catapult::Height  height 
)
inlineexplicitprotected

Creates a lock info around account, mosaicId, amount and height.

Member Function Documentation

◆ isActive()

constexpr bool catapult::state::LockInfo::isActive ( catapult::Height  height) const
inlineconstexpr

Returns true if lock info is active at height.

Member Data Documentation

◆ Account

Key catapult::state::LockInfo::Account

Account.

◆ Amount

catapult::Amount catapult::state::LockInfo::Amount

Amount.

◆ Height

catapult::Height catapult::state::LockInfo::Height

Height at which the lock expires.

◆ MosaicId

catapult::MosaicId catapult::state::LockInfo::MosaicId

Mosaic id.

◆ Status

LockStatus catapult::state::LockInfo::Status

Flag indicating whether or not the lock was already used.


The documentation for this struct was generated from the following file: