Global Properties

Overview

The GlobalProperty class manages global properties such as problem title, physical constants, originating commercial vendor name, etc. The functions associated with a GlobalProperty object are the following.

The functions associated with a GlobalProperty object are the following:

Specify integer valued properties using setPropertyIntegerValue. Specify character valued properties using setPropertyStringValue(). Each property type is identified by a defined constant. The user queries for the number of properties defined using getPropertyCount(). The number of components associated with a property type is queried using getPropertyInformation(). A long descriptive name which is hard-wired to each property type may be queried using getPropertyName(). Finally the property values themselves may be recovered using getPropertyIntegerValue or getPropertyDoubleValue().

The function getPropertyFlag() is used to determine if a property has been defined.

Each property has an associated data type, integer, character or real.

Class Members Descriptions

The currently available GlobalProperty enumerations and functions are described in detail in this section.

class GlobalProperty

Global property class for managing global properties.

Public Types

enum class PropertyFlag

Global property value flag.

Values:

enumerator UNDEFINED

Property value not defined.

enumerator VALUE

Property defined with a value.

enumerator IDENTIFIER

Property defined with an TableFunction identifier.

enum class StringProperty

Global character valued property types.

Values:

enumerator TITLE

Title.

enumerator SUBTITLE

Subtitle.

enumerator ORIGINATING_CODE

Originating code.

enumerator ORIGINATING_VERSION

Originating code version.

enumerator ORIGINATING_TIME

Originating time.

enumerator ORIGINATING_DATE

Originating date.

enum class IntegerProperty

Global integer values property types.

Values:

enumerator LIBRARY

Access import library file format type.

enumerator AUTOSPC

Auto SPC flag.

enumerator CYCLIC_SECTOR_COUNT

Cyclic Mode analysis: number of cyclic sectors.

enumerator DEFINED_SYMMETRY_COUNT

cyclic symmetry: number of defined symmetries

enumerator SYMMETRY_IDS

cyclic symmetry: list of symmetries Ids [DEFINED_SYMMETRY_COUNT]

enumerator CYLINDRICAL_COORDINATE_SYSTEM_IDS

cyclic symmetry: list of cylind. coord. systems Ids [DEFINED_SYMMETRY_COUNT]

enumerator SYMMETRY_NUMBER_OF_SECTORS

cyclic symmetry: number of sections for each symmetry [DEFINED_SYMMETRY_COUNT]

enumerator SECTOR_ID

Symmetry group stage or sector Id [DEFINED_SYMMETRY_COUNT].

enumerator CYCLIC_CYLINDRICAL_COORD_SYSTEM_ID

Cyclic Mode analysis: Reference Cylindrical coord syst ID.

enumerator PERMANENT_GLUE

Contact computed at 1st step and frozen for the whole computation.

enumerator SYMMETRY_EMBEDDED_SET_ID

Symmetry group embedded element set id [DEFINED_SYMMETRY_COUNT].

enumerator EXPORT_VENDOR

Export Vendor type.

enumerator IMPORT_VENDOR

Import Vendor type.

enumerator AXIS_2D

2D rotation axis

enumerator PLANE_2D

2D plane orientation type

enumerator ANALYSIS_TYPE_2D

2D analysis type

enum class DoubleProperty

Global real values property types.

Values:

enumerator CYCLIC_ORIGIN

Cyclic Mode analysis: origin of cyclic coordinate System(x, y, z) [3].

enumerator CYCLIC_AXIS

Cyclic Mode analysis: axis of cyclic coordinate System(x, y, z) [3].

enumerator STEFAN_BOLTZMANN

Stefan Boltzmann constant.

enumerator ABSOLUTE_ZERO_TEMPERATURE

Absolute Zero Temperature.

enumerator SYMMETRY_ORIGIN

Origin of symmetry coordinate System (x, y, z) [DEFINED_SYMMETRY_COUNT][3].

enumerator SYMMETRY_AXIS

Axis of symmetry coordinate System(x, y, z) [DEFINED_SYMMETRY_COUNT][3].

enumerator STRUCTURAL_DAMPING_COEFFICIENT

Structural damping coefficient.

Public Functions

ErrorCode getErrorCode()

Return the current ErrorCode of the MaterialProperty object.

Returns: ErrorCode - The current error code, or NONE if no error.
Status setPropertyDoubleValue(DoubleProperty type, double value)

Set a real valued property.

Use getPropertyDoubleValue() to return real valued properties.

Parameters:
Returns:

Status

Status setPropertyDoubleArray(DoubleProperty type, double values[])

Set real valued properties. The number of properties expected in values is equal to the the number of values associated with the property type.

Use getPropertyDoubleValue() to return real valued properties.

Parameters:
Returns:

Status

Status setPropertyStringValue(StringProperty type, const char *value)

Set character property. The terminating null character, if present, is also set.

Use getPropertyStringValue() to return character valued properties as a string

Parameters:
Returns:

Status

Status unsetProperty(IntegerProperty type)

Unset an integer valued property.

Parameters:type – IntegerProperty
Returns:Status
Status unsetProperty(DoubleProperty type)

Unset an real valued property.

Parameters:type – DoubleProperty
Returns:Status
Status unsetProperty(StringProperty type)

Unset an srting valued property.

Parameters:type – StringProperty
Returns:Status
Status getPropertyCount(int *count)

Query number of global property types.

Parameters:count – [out] Number of types of property values
Returns:Status
Status getPropertyFlag(IntegerProperty type, PropertyFlag *flag)

Query for integer valued property definition. If a property value is not defined, UNDEFINED is returned.

Parameters:
Returns:

Status

Status getPropertyFlag(DoubleProperty type, PropertyFlag *flag)

Query for real valued property definition. If a property value is not defined, UNDEFINED is returned.

Parameters:
Returns:

Status

Status getPropertyFlag(StringProperty type, PropertyFlag *flag)

Query for string valued property definition. If a property value is not defined, UNDEFINED is returned.

Parameters:
Returns:

Status

Status getPropertyInformation(IntegerProperty type, int *componentsCount)

Query for the number of components of an integer property type.

Parameters:
Returns:

Status

Status getPropertyInformation(DoubleProperty type, int *componentsCount)

Query for the number of components of an real property type.

Parameters:
  • type – DoubleProperty
  • componentsCount – [out] Number of components
Returns:

Status

Status getPropertyInformation(StringProperty type, int *componentsCount)

Query for the number of components and number of locations of an string property type.

Parameters:
  • type – StringProperty
  • componentsCount – [out] Number of components
Returns:

Status

Status getPropertyName(IntegerProperty type, char name[])

Query for the built-in name associated with an integer property type. The character string will not exceed 64 characters including the terminating NULL character.

Parameters:
Returns:

Status

Status getPropertyName(DoubleProperty type, char name[])

Query for the built-in name associated with a real property type. The character string will not exceed 64 characters including the terminating NULL character.

Parameters:
Returns:

Status

Status getPropertyName(StringProperty type, char name[])

Query for the built-in name associated with a string property type. The character string will not exceed 64 characters including the terminating NULL character.

Parameters:
Returns:

Status

Status getPropertyDoubleValue(DoubleProperty type, double values[])

Return a defined real valued property as double. The number of values returned is equal to the number of components associated with the specified property. If the value has not been defined, nothing is returned.

Parameters:
Returns:

Status

Status getPropertyStringValue(StringProperty type, char value[])

Return a defined character valued property as a string. If the value has not been defined, nothing is returned.

Parameters:
Returns:

Status

Status print()

Print the contents of the GlobalProperty object to standard output.

Returns:Status
template<auto IntegerPropertyType, typename PropertyValue>
Status setPropertyIntegerValue(PropertyValue value)

Set a integer valued global property. The integer valued property type is specified as a template parameter to ensure type safety. Use getPropertyIntegerValue() to return integer valued properties.

Template Parameters:
 
Parameters:

value – Property value
Returns:

Status

template<auto IntegerPropertyType, typename PropertyValue>
Status setPropertyIntegerArray(PropertyValue values[])

Set integer valued properties. The number of properties expected in values is equal to the the number of values associated with the property type.

Use getPropertyIntegerValue() to return integer valued properties.

Template Parameters:
 
Parameters:

values – Property values

Returns:

Status

template<auto IntegerPropertyType, typename PropertyValue>
Status getPropertyIntegerValue(PropertyValue values[])

Return a defined global integer valued property. If the value has not been defined, nothing is returned.

Template Parameters:
 
Parameters:

values – [out] Integer property values

Returns:

Status