rippled
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
xrpl::ledger_entries::NegativeUNL Class Reference

Ledger Entry: NegativeUNL. More...

#include <NegativeUNL.h>

Inheritance diagram for xrpl::ledger_entries::NegativeUNL:
Inheritance graph
[legend]
Collaboration diagram for xrpl::ledger_entries::NegativeUNL:
Collaboration graph
[legend]

Public Member Functions

 NegativeUNL (std::shared_ptr< SLE const > sle)
 Construct a NegativeUNL ledger entry wrapper from an existing SLE object.
 
std::optional< std::reference_wrapper< STArray const > > getDisabledValidators () const
 Get sfDisabledValidators (soeOPTIONAL)
 
bool hasDisabledValidators () const
 Check if sfDisabledValidators is present.
 
protocol_autogen::Optional< SF_VL::type::value_type > getValidatorToDisable () const
 Get sfValidatorToDisable (soeOPTIONAL)
 
bool hasValidatorToDisable () const
 Check if sfValidatorToDisable is present.
 
protocol_autogen::Optional< SF_VL::type::value_type > getValidatorToReEnable () const
 Get sfValidatorToReEnable (soeOPTIONAL)
 
bool hasValidatorToReEnable () const
 Check if sfValidatorToReEnable is present.
 
protocol_autogen::Optional< SF_UINT256::type::value_type > getPreviousTxnID () const
 Get sfPreviousTxnID (soeOPTIONAL)
 
bool hasPreviousTxnID () const
 Check if sfPreviousTxnID is present.
 
protocol_autogen::Optional< SF_UINT32::type::value_type > getPreviousTxnLgrSeq () const
 Get sfPreviousTxnLgrSeq (soeOPTIONAL)
 
bool hasPreviousTxnLgrSeq () const
 Check if sfPreviousTxnLgrSeq is present.
 
bool validate () const
 Validate the ledger entry.
 
LedgerEntryType getType () const
 Get the ledger entry type.
 
uint256 const & getKey () const
 Get the key (index) of this ledger entry.
 
std::optional< uint256getLedgerIndex () const
 Get the ledger index (sfLedgerIndex).
 
bool hasLedgerIndex () const
 Check if the ledger entry has a ledger index.
 
uint16_t getLedgerEntryType () const
 Get the ledger entry type field (sfLedgerEntryType).
 
std::uint32_t getFlags () const
 Get the flags field (sfFlags).
 
std::shared_ptr< SLE const > getSle () const
 Get the underlying SLE object.
 

Static Public Attributes

static constexpr LedgerEntryType entryType = ltNEGATIVE_UNL
 

Protected Attributes

std::shared_ptr< SLE const > sle_
 The underlying serialized ledger entry being wrapped.
 

Detailed Description

Ledger Entry: NegativeUNL.

Type: ltNEGATIVE_UNL (0x004e) RPC Name: nunl

Immutable wrapper around SLE providing type-safe field access. Use NegativeUNLBuilder to construct new ledger entries.

Definition at line 27 of file NegativeUNL.h.

Constructor & Destructor Documentation

◆ NegativeUNL()

xrpl::ledger_entries::NegativeUNL::NegativeUNL ( std::shared_ptr< SLE const >  sle)
explicit

Construct a NegativeUNL ledger entry wrapper from an existing SLE object.

Exceptions
std::runtime_errorif the ledger entry type doesn't match.

Definition at line 36 of file NegativeUNL.h.

Member Function Documentation

◆ getDisabledValidators()

std::optional< std::reference_wrapper< STArray const > > xrpl::ledger_entries::NegativeUNL::getDisabledValidators ( ) const

Get sfDisabledValidators (soeOPTIONAL)

Note
This is an untyped field (unknown).
Returns
The field value, or std::nullopt if not present.

Definition at line 55 of file NegativeUNL.h.

◆ hasDisabledValidators()

bool xrpl::ledger_entries::NegativeUNL::hasDisabledValidators ( ) const

Check if sfDisabledValidators is present.

Returns
True if the field is present, false otherwise.

Definition at line 68 of file NegativeUNL.h.

◆ getValidatorToDisable()

protocol_autogen::Optional< SF_VL::type::value_type > xrpl::ledger_entries::NegativeUNL::getValidatorToDisable ( ) const

Get sfValidatorToDisable (soeOPTIONAL)

Returns
The field value, or std::nullopt if not present.

Definition at line 79 of file NegativeUNL.h.

◆ hasValidatorToDisable()

bool xrpl::ledger_entries::NegativeUNL::hasValidatorToDisable ( ) const

Check if sfValidatorToDisable is present.

Returns
True if the field is present, false otherwise.

Definition at line 92 of file NegativeUNL.h.

◆ getValidatorToReEnable()

protocol_autogen::Optional< SF_VL::type::value_type > xrpl::ledger_entries::NegativeUNL::getValidatorToReEnable ( ) const

Get sfValidatorToReEnable (soeOPTIONAL)

Returns
The field value, or std::nullopt if not present.

Definition at line 103 of file NegativeUNL.h.

◆ hasValidatorToReEnable()

bool xrpl::ledger_entries::NegativeUNL::hasValidatorToReEnable ( ) const

Check if sfValidatorToReEnable is present.

Returns
True if the field is present, false otherwise.

Definition at line 116 of file NegativeUNL.h.

◆ getPreviousTxnID()

protocol_autogen::Optional< SF_UINT256::type::value_type > xrpl::ledger_entries::NegativeUNL::getPreviousTxnID ( ) const

Get sfPreviousTxnID (soeOPTIONAL)

Returns
The field value, or std::nullopt if not present.

Definition at line 127 of file NegativeUNL.h.

◆ hasPreviousTxnID()

bool xrpl::ledger_entries::NegativeUNL::hasPreviousTxnID ( ) const

Check if sfPreviousTxnID is present.

Returns
True if the field is present, false otherwise.

Definition at line 140 of file NegativeUNL.h.

◆ getPreviousTxnLgrSeq()

protocol_autogen::Optional< SF_UINT32::type::value_type > xrpl::ledger_entries::NegativeUNL::getPreviousTxnLgrSeq ( ) const

Get sfPreviousTxnLgrSeq (soeOPTIONAL)

Returns
The field value, or std::nullopt if not present.

Definition at line 151 of file NegativeUNL.h.

◆ hasPreviousTxnLgrSeq()

bool xrpl::ledger_entries::NegativeUNL::hasPreviousTxnLgrSeq ( ) const

Check if sfPreviousTxnLgrSeq is present.

Returns
True if the field is present, false otherwise.

Definition at line 164 of file NegativeUNL.h.

◆ validate()

bool xrpl::ledger_entries::LedgerEntryBase::validate ( ) const
inherited

Validate the ledger entry.

Returns
true if validation passes, false otherwise

Definition at line 40 of file LedgerEntryBase.h.

◆ getType()

LedgerEntryType xrpl::ledger_entries::LedgerEntryBase::getType ( ) const
inherited

Get the ledger entry type.

Returns
The type of this ledger entry

Definition at line 57 of file LedgerEntryBase.h.

◆ getKey()

uint256 const & xrpl::ledger_entries::LedgerEntryBase::getKey ( ) const
inherited

Get the key (index) of this ledger entry.

The key uniquely identifies this ledger entry in the ledger state.

Returns
A constant reference to the 256-bit key

Definition at line 70 of file LedgerEntryBase.h.

◆ getLedgerIndex()

std::optional< uint256 > xrpl::ledger_entries::LedgerEntryBase::getLedgerIndex ( ) const
inherited

Get the ledger index (sfLedgerIndex).

This field is OPTIONAL and represents the index of the ledger entry.

Returns
The ledger index if present, std::nullopt otherwise

Definition at line 85 of file LedgerEntryBase.h.

◆ hasLedgerIndex()

bool xrpl::ledger_entries::LedgerEntryBase::hasLedgerIndex ( ) const
inherited

Check if the ledger entry has a ledger index.

Returns
true if sfLedgerIndex is present, false otherwise

Definition at line 100 of file LedgerEntryBase.h.

◆ getLedgerEntryType()

uint16_t xrpl::ledger_entries::LedgerEntryBase::getLedgerEntryType ( ) const
inherited

Get the ledger entry type field (sfLedgerEntryType).

This field is REQUIRED for all ledger entries and indicates the type of the ledger entry (e.g., AccountRoot, RippleState, Offer, etc.).

Returns
The ledger entry type as a 16-bit unsigned integer

Definition at line 114 of file LedgerEntryBase.h.

◆ getFlags()

std::uint32_t xrpl::ledger_entries::LedgerEntryBase::getFlags ( ) const
inherited

Get the flags field (sfFlags).

This field is REQUIRED for all ledger entries and contains type-specific flags that modify the behavior of the ledger entry.

Returns
The flags value as a 32-bit unsigned integer

Definition at line 128 of file LedgerEntryBase.h.

◆ getSle()

std::shared_ptr< SLE const > xrpl::ledger_entries::LedgerEntryBase::getSle ( ) const
inherited

Get the underlying SLE object.

Provides direct access to the wrapped serialized ledger entry object for cases where the type-safe accessors are insufficient.

Returns
A constant reference to the underlying SLE object

Definition at line 142 of file LedgerEntryBase.h.

Member Data Documentation

◆ entryType

constexpr LedgerEntryType xrpl::ledger_entries::NegativeUNL::entryType = ltNEGATIVE_UNL
staticconstexpr

Definition at line 30 of file NegativeUNL.h.

◆ sle_

std::shared_ptr<SLE const> xrpl::ledger_entries::LedgerEntryBase::sle_
protectedinherited

The underlying serialized ledger entry being wrapped.

Definition at line 149 of file LedgerEntryBase.h.