Skip to main content
JSON Manual Created Edited

Time History Functions

Input URI

{base url} + db/THFC



Active Methods

POST, GET, PUT, DELETE



JSON Schema

Details

{
    "THFC": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "type": "object",
        "properties": {
            "NAME": {
                "description": "Timehistoryfunctionname",
                "type": "string"
            },
            "FUNCTYPE": {
                "description": "Timehistoryfunctiontype-Time",
                "type": "integer"
            },
            "iTYPE": {
                "description": "Timefunctiondatatype",
                "type": "integer"
            },
            "iMETHOD": {
                "description": "Scalingmethod",
                "type": "integer"
            },
            "SCALE": {
                "description": "Scalefactor",
                "type": "number"
            },
            "MAXVALUE": {
                "description": "MaximumValue",
                "type": "number"
            },
            "GRAV": {
                "description": "Gravity",
                "type": "number"
            },
            "aFUNCDATA": {
                "description": "TimeValueList",
                "type": "array",
                "items": {
                    "type": "object",
                    "properties": {
                        "TIME": {
                            "description": "Time",
                            "type": "number"
                        },
                        "VALUE": {
                            "description": "Value",
                            "type": "number"
                        }
                    }
                }
            },
            "CONS_A": {
                "description": "ConstantA",
                "type": "number"
            },
            "CONS_C": {
                "description": "ConstantC",
                "type": "number"
            },
            "FREQUENCY": {
                "description": "Frequency",
                "type": "number"
            },
            "DAMP_FACTOR": {
                "description": "DampingFactor",
                "type": "number"
            },
            "PHASE_ANGLE": {
                "description": "PhaseAngle",
                "type": "number"
            },
            "DESC": {
                "description": "Description",
                "type": "string"
            }
        }
    }
}


Examples

Time Function

{
    "Assign": {
        "4": {
            "NAME": "ElCentroSite_Scale",
            "FUNCTYPE": 1,
            "iTYPE": 1,
            "iMETHOD": 0,
            "SCALE": 1,
            "GRAV": 9.806,
            "aFUNCDATA": [
                {
                    "TIME": 0.02,
                    "VALUE": 0.0051703039
                },
                {
                    "TIME": 0.04,
                    "VALUE": 0.0042117071
                },
                {
                    "TIME": 0.06,
                    "VALUE": 0.0032429125
                }
            ],
            "DESC": "1940,ElCentroSite,270Deg"
        },
        "5": {
            "NAME": "ElCentroSite_Max",
            "FUNCTYPE": 1,
            "iTYPE": 1,
            "iMETHOD": 1,
            "MAXVALUE": 0.2,
            "GRAV": 9.806,
            "aFUNCDATA": [
                {
                    "TIME": 0.02,
                    "VALUE": 0.0051703039
                },
                {
                    "TIME": 0.04,
                    "VALUE": 0.0042117071
                },
                {
                    "TIME": 0.06,
                    "VALUE": 0.0032429125
                }
            ],
            "DESC": "1940,ElCentroSite,270Deg"
        }
    }
}

Sinusoidal

{
    "Assign": {
        "6": {
            "NAME": "Sinusoidal",
            "FUNCTYPE": 2,
            "iTYPE": 1,
            "GRAV": 9.806,
            "CONS_A": 0.05,
            "CONS_C": 0.01,
            "FREQUENCY": 1,
            "DAMP_FACTOR": 0.1,
            "PHASE_ANGLE": 0.2,
            "DESC": "Examples"
        }
    }
}


Specifications

No. Description Key Value Type Default Required

1

Time History Function Name

"NAME"

String

-

Required

2

Description

"DESC"

String

Blank

Optional

3

Time Function Data Type

 • Normalized Accel.: 1

 • Acceleration: 2

 • Force: 3

 • Moment: 4

 • Normal: 5

"iTYPE"

Integer

-

Required

4

Gravity

"GRAV"

Number

-

Required

5

Time History Function Type

 • Time Function: 1

 • Sinusoidal: 2

"FUNCTYPE"

Integer

-

Required

When Time History Function Type, "FUNCTYPE" is 1 (Time Function)

6

Scaling Method

 • Scale Factor: 0

 • Maximum Value: 1

"iMETHOD"

Integer

-

Required

7

Scale Factor

 • if "iMETHOD": 0

"SCALE"

Number

-

Required

7

Maximum Value

 • if "iMETHOD": 1

"MAXVALUE"

Number

0

Optional

8

Time Value List

"aFUNCDATA"

Object

-

Required

(1)

Time

"TIME"

Number

-

Required

(2)

Value

"VALUE"

Number

-

Required

When Time History Function Type, "FUNCTYPE" is 2 (Sinusoidal)

6

Constant A

"CONS_A"

Number

-

Required

7

Constant C

"CONS_C"

Number

-

Required

8

Frequency

"FREQUENCY"

Number

-

Required

9

Damping Factor

"DAMP_FACTOR"

Number

-

Required

10

Phase Angle

"PHASE_ANGLE"

Number

-

Required



0
Was this article helpful?