Class AddMemRefCmd

java.lang.Object
ghidra.app.cmd.refs.AddMemRefCmd
All Implemented Interfaces:
Command<Program>

public class AddMemRefCmd extends Object implements Command<Program>
Command class to add a memory reference to the program.
  • Constructor Details

    • AddMemRefCmd

      public AddMemRefCmd(Address fromAddr, Address toAddr, SourceType source, int opIndex, boolean setPrimary)
      Command constructor for adding a memory reference with a default refType
      Parameters:
      fromAddr - address of the codeunit where the reference occurs
      toAddr - address of the location being referenced.
      source - the source of the reference
      opIndex - the operand index in the code unit where the reference occurs
      setPrimary - true if this reference should be primary.
    • AddMemRefCmd

      public AddMemRefCmd(Address fromAddr, Address toAddr, RefType refType, SourceType source, int opIndex)
      Command constructor for adding a memory reference
      Parameters:
      fromAddr - address of the codeunit where the reference occurs
      toAddr - address of the location being referenced.
      refType - reference type - how the location is being referenced.
      source - the source of the reference
      opIndex - the operand index in the code unit where the reference occurs
    • AddMemRefCmd

      public AddMemRefCmd(Address fromAddr, Address toAddr, RefType refType, SourceType source, int opIndex, boolean setPrimary)
      Command constructor for adding a memory reference
      Parameters:
      fromAddr - address of the codeunit where the reference occurs
      toAddr - address of the location being referenced.
      refType - reference type - how the location is being referenced.
      source - the source of the reference
      opIndex - the operand index in the code unit where the reference occurs
      setPrimary - set the newly added reference primary
  • Method Details

    • applyTo

      public boolean applyTo(Program program)
      Description copied from interface: Command
      Applies the command to the given domain object.
      Specified by:
      applyTo in interface Command<Program>
      Parameters:
      program - domain object that this command is to be applied.
      Returns:
      true if the command applied successfully
    • getStatusMsg

      public String getStatusMsg()
      Description copied from interface: Command
      Returns the status message indicating the status of the command.
      Specified by:
      getStatusMsg in interface Command<Program>
      Returns:
      reason for failure, or null if the status of the command was successful
    • getName

      public String getName()
      Description copied from interface: Command
      Returns the name of this command.
      Specified by:
      getName in interface Command<Program>
      Returns:
      the name of this command