Package ghidra.app.cmd.refs

Class AddMemRefCmd

java.lang.Object

ghidra.app.cmd.refs.AddMemRefCmd

All Implemented Interfaces:

Command

public class AddMemRefCmd
extends java.lang.Object
implements Command

Command class to add a memory reference to the program.

Constructor Summary

Constructors

Constructor	Description
AddMemRefCmd(Address fromAddr, Address toAddr, RefType refType, SourceType source, int opIndex)	Command constructor for adding a memory reference
AddMemRefCmd(Address fromAddr, Address toAddr, RefType refType, SourceType source, int opIndex, boolean setPrimary)	Command constructor for adding a memory reference
AddMemRefCmd(Address fromAddr, Address toAddr, SourceType source, int opIndex, boolean setPrimary)	Command constructor for adding a memory reference with a default refType

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

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 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()