HeaderDoc::Struct

Declared In:

Struct.pm

Introduction

API object that that describes a data structure (struct or record).

The Struct class stores information relating to a data structure declaration.

This class is a subclass of HeaderElement. The majority of related fields and functions can be found there.

_initialize: Initializes an instance of a Struct object.
clone: Duplicates this Struct object into another one.
fields: Gets/sets the array of fields that are associated with a struct or union.
isUnion: Gets/sets whether this is actually a union.
printObject: Prints this object for debugging purposes.
setDeclaration: Sets the declaration.

Initializes an instance of a Struct object.

sub _initialize

Duplicates this Struct object into another one.

sub clone

Gets/sets the array of fields that are associated with a struct or union.

sub fields

Gets/sets whether this is actually a union.

sub isUnion

The same HeaderDoc class is used for both struct and union declarations. This allows you to tell one from the other.

Prints this object for debugging purposes.

sub printObject

Sets the declaration.

sub setDeclaration

FIELDS: An array of fields in this structure. See fields.
HeaderDoc::Struct::VERSION: The revision control revision number for this module.
ISUNION: Holds 1 if this object holds a union, 0 if it holds a struct. See isUnion.

An array of fields in this structure. See fields.

$self->{FIELDS}

The revision control revision number for this module.

$HeaderDoc::Struct::VERSION = '$Revision: 1298084579 $';

In the git repository, contains the number of seconds since January 1, 1970.

Holds 1 if this object holds a union, 0 if it holds a struct. See isUnion.

$self->{ISUNION}

Last Updated: Saturday, August 06, 2016