com.steptools.stdev.p21

Class Header

java.lang.Object

com.steptools.stdev.p21.Header

public class Header
extends Object

Provides a convient interface for the STEP Part 21 header instances. This class can be used to get the values that will be include in a Part21 header for a model to either update the instances, or to get their values.

Method Summary

Methods

Modifier and Type	Method and Description
static Header	forModel(Model model) Get the header for a given Model.
com.steptools.schemas.header_section_schema.File_description	getFileDescription() Create, if necessary, and retrieve the header's File_description object.
com.steptools.schemas.header_section_schema.File_name	getFileName() Create, if necessary, and retrieve the header's File_name object.
com.steptools.schemas.header_section_schema.Population	getPopulation() Get the population object for the header.

Methods inherited from class java.lang.Object

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

Method Detail

forModel

public static Header forModel(Model model)

Get the header for a given Model. In no header object currently exists, create one.

Parameters:

model - the model for which to get the header.

Returns:

The header for the given model.

getPopulation

public com.steptools.schemas.header_section_schema.Population getPopulation()

Get the population object for the header. If one does not exist, it is created.

Returns:

the Population of header objects in this model.

getFileName

public com.steptools.schemas.header_section_schema.File_name getFileName()

Create, if necessary, and retrieve the header's File_name object. The File_name object will have the author and organization lists created, if they do not already exist.

Returns:

the header's File_name instance.

getFileDescription

public com.steptools.schemas.header_section_schema.File_description getFileDescription()

Create, if necessary, and retrieve the header's File_description object. The returned object will have the description list created, if it does not already exist.

Returns:

the header's File_description instance.