Package ghidra.app.cmd.refs

Class AddRegisterRefCmd

java.lang.Object

ghidra.app.cmd.refs.AddRegisterRefCmd

All Implemented Interfaces:

Command

public class AddRegisterRefCmd
extends java.lang.Object
implements Command

Command class to add a register reference to the program.

Constructor Summary

Constructors

Constructor	Description
AddRegisterRefCmd(Address fromAddr, int opIndex, Register reg, RefType refType, SourceType source)	Constructs a new command for adding a register reference.
AddRegisterRefCmd(Address fromAddr, int opIndex, Register reg, SourceType source)	Constructs a new command for adding a register reference.

Method Summary

Modifier and Type	Method	Description
boolean	applyTo(DomainObject obj)	Applies the command to the given domain object.
java.lang.String	getName()	Returns the name of this command.
java.lang.String	getStatusMsg()	Returns the status message indicating the status of the command.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddRegisterRefCmd

public AddRegisterRefCmd(Address fromAddr,
                         int opIndex,
                         Register reg,
                         SourceType source)

Constructs a new command for adding a register reference.

Parameters:

fromAddr - "from" address

opIndex - operand index

reg - register to add the reference to

source - the source of this reference

AddRegisterRefCmd

public AddRegisterRefCmd(Address fromAddr,
                         int opIndex,
                         Register reg,
                         RefType refType,
                         SourceType source)

Constructs a new command for adding a register reference.

Parameters:

fromAddr - "from" address

opIndex - operand index

reg - register to add the reference to

refType - reference type or null to use a default RefType

source - the source of this reference

Method Detail

applyTo

public boolean applyTo(DomainObject obj)

Description copied from interface: Command

Applies the command to the given domain object.

Specified by:

applyTo in interface Command

Parameters:

obj - domain object that this command is to be applied.

Returns:

true if the command applied successfully

See Also:

Command.applyTo(ghidra.framework.model.DomainObject)

getStatusMsg

public java.lang.String getStatusMsg()

Description copied from interface: Command

Returns the status message indicating the status of the command.

Specified by:

getStatusMsg in interface Command

Returns:

reason for failure, or null if the status of the command was successful

See Also:

Command.getStatusMsg()

getName

public java.lang.String getName()

Description copied from interface: Command

Returns the name of this command.

Specified by:

getName in interface Command

Returns:

the name of this command

See Also:

Command.getName()