HistoryRegion object

The HistoryRegion object contains history data for a single location in the model.

The following topics are discussed:

Access
HistoryRegion(...)
getSubset(...)
getSubset(...)
getSubset(...)
Members

Access

odb.steps()[name].historyRegions()[name]

HistoryRegion(...)

This method creates a HistoryRegion object.

Path

odb.steps()[name].HistoryRegion

Prototype

odb_HistoryRegion&
HistoryRegion(const odb_String& name,
              const odb_String& description,
              const odb_HistoryPoint& point,
              const odb_LoadCase& loadCase);

Required arguments

name: An odb_String specifying the name of the HistoryRegion object.
description: An odb_String specifying the description of the HistoryRegion object.
point: A HistoryPoint object specifying the point to which the history data refer.

Optional arguments

loadCase: An OdbLoadCase object specifying the load case associated with the HistoryRegion object.

Return value

A HistoryRegion object.

Exceptions

None.

getSubset(...)

This method returns a subset of the data in the HistoryRegion object.

Prototype

odb_HistoryRegion
getSubset(const odb_String& variableName);

Required arguments

variableName: A String specifying the name of the output variable to return.

Optional arguments

None.

Return value

A HistoryRegion object.

Exceptions

None.

getSubset(...)

This method returns a subset of the data in the HistoryRegion object.

Prototype

odb_HistoryRegion
getSubset(float start);

Required arguments

start: A Float specifying the start of the subset. This is the same as the first item in the data array member of the HistoryOutput object.

Optional arguments

None.

Return value

A HistoryRegion object.

Exceptions

None.

getSubset(...)

This method returns a subset of the data in the HistoryRegion object.

Prototype

odb_HistoryRegion
getSubset(float start,
          float end);

Required arguments

start: A Float specifying the start of the subset. This is the same as the first item in the data array member of the HistoryOutput object.
end: A Float specifying the end of the subset.

Optional arguments

None.

Return value

A HistoryRegion object.

Exceptions

None.

Members

The HistoryRegion object has members with the same names and descriptions as the arguments to the HistoryRegion method.

In addition, the HistoryRegion object can have the following members:

Prototype

odb_String description() const;
const odb_LoadCase& loadCase() const;
odb_String name() const;
odb_HistoryPoint point() const;
odb_Enum::odb_ResultPositionEnum position() const;
const odb_HistoryOutputRepository& historyOutputs();

position: An odb_Enum::odb_ResultPositionEnum specifying the position of the history output. Possible values are odb_Enum::NODAL, odb_Enum::INTEGRATION_POINT, odb_Enum::WHOLE_ELEMENT, odb_Enum::WHOLE_REGION, and odb_Enum::WHOLE_MODEL.
historyOutputs: A repository of HistoryOutput objects.