Package ghidra.app.cmd.data

Class CreateArrayInStructureCmd

java.lang.Object

ghidra.app.cmd.data.CreateArrayInStructureCmd

All Implemented Interfaces:

Command

public class CreateArrayInStructureCmd
extends java.lang.Object
implements Command

Command to create an array inside of a structure.

Constructor Summary

Constructors

Constructor	Description
CreateArrayInStructureCmd(Address addr, int numElements, DataType dt, int[] compPath)	Constructs a new command for creating arrays inside of structures.

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

CreateArrayInStructureCmd

public CreateArrayInStructureCmd(Address addr,
                                 int numElements,
                                 DataType dt,
                                 int[] compPath)

Constructs a new command for creating arrays inside of structures.

Parameters:

addr - The address of the structure that will contain the new array.

numElements - the number of elements in the array to be created.

dt - the dataType of the elements in the array to be created.

compPath - the component path within the structure at which to create the array. The component path is an array of integers where each integer is a component index of the component above it.

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