Skip to content

Get Object Information

Description

Get information about the modal and physical properties of an object, using the standard (get-info ... ) function.

(get-info ... )

Syntax and Default Values

The generic (get-info ... ) function can be used to obtain object-specific information using the following Lisp syntax:

(get-info data_type object_reference)
or:

(get-info data_type object_reference mode_number )
or:

(get-info data_type object_reference mode_number point_number)
or:

(get-info 'physical data_type object_reference)

Parameters

The (get-info ... ) function requires the following arguments to get information about an object:

  • data_type: a string defining the type of data to request.
  • object_reference: an object.
  • mode_number: mode whose information is being queried.
  • point_number: point whose information is being queried.

The following types of object-specific data can be requested using the standard (get-info ...) function, using just an object reference:

  • 'num-modes
  • 'num-points

The following types of object-specific mode data can be obtained an object reference and a mode number (starting from mode 0):

  • 'mode-frequency
  • 'mode-loss
  • 'energy

Mode shape data can be obtained an object reference followed by a mode number (starting from mode 0), and a point number (starting fom 0):

  • 'mode-shape

The following are examples of all types:

(get-info 'num-modes my-string)
(get-info 'num-points my-string)
(get-info 'mode-frequency my-string 0)
(get-info 'mode-loss my-string 0)
(get-info 'mode-shape my-string 0 0)
(get-info 'energy my-string 0)

Physical Information

The following types of object-specific physical parameter data can be requested using (get-info 'physical ...) function:

  • length
  • width
  • thickness
  • radius
  • tension
  • stiffness
  • density
  • young
  • poisson
  • air-density
  • air-elasticity
  • rho
  • celerity

Note that the type of information available for each object depends on the physical parameters of the object itself. These are listed in the instantiation syntax on each object's reference page.

An example:

(get-info 'physical 'length my-string)

Options

Retro-Compatibility

Older versions of Modalys used a slightly different ordering for (get-info 'physical ... ):

(get-info 'physical object_reference data_type)
Some older Modalys scripts may therefore need to be updated by reversing the object reference and data type string.