Volumetric
There are a number of commands designed to help you to control the definition and graphical display of the Volumetric object that can be executed through Connect.
| Command | Format | Description | Version |
|---|---|---|---|
| Copy | Copy <ApplicationPath> <CopyFromObjectPath> [{CopyOption}] | Copy and paste an object. | 8.0 |
| GetDescription | GetDescription <ObjectPath> {Type} | Return the description of an object | 4.0.6 |
| Load | Load <ApplicationPath> {<ClassPath> | VDF} "<FilePath>" | Open an existing scenario or insert an object into the current scenario | 8.0 |
| New | New <ApplicationPath> <ClassPath> <NewObjectName> {NewOptions} | Create a new scenario or add a new object to the current scenario | 8.1 |
| NewMulti | NewMulti <ApplicationPath> <ClassPathOfObjectToCreate> <NumToCreate> <NewName1> [<NewName2>...] [NoDefault] [Ignore] | Create multiple instances of new objects | 4.2 |
| Save | Save <ApplicationPath> <ObjectPath> ["<SaveInDirectory>"] | Save a scenario or object within a scenario | 4.0 |
| SaveAs | SaveAs <ApplicationPath> <ObjectPath> "<FilePath>" | Save a scenario or object within a scenario with a different name | 4.2 |
| SetAsDefault | SetAsDefault <ApplicationPath> [<ObjectPath>] | Save the indicated object as the default | 4.2 |
| SetDescription | SetDescription <ObjectPath> {Type} [{Option}] "<Description>" | Set the long or short description of a scenario or object | 6.2 |
| SpatialTool | SpatialTool <ScenarioPath> {Options} | Define volumes and elements used in constructing them, including templates. | 11.5 |
| SpatialTool Spatial Calculation | SpatialTool <ScenarioPath> <ParentObject> {Action} {Spatial Calculation | Spatial CalculationTemplate} <Spatial CalculationName> [{Spatial CalculationType} <Spatial CalculationTypeParams>] | Define and modify Spatial Calculation components and templates. | 11.5 |
| SpatialTool Spatial Condition | SpatialTool <ScenarioPath> <ParentObject> {Action} {Spatial Condition | Spatial ConditionTemplate} <Spatial ConditionName> [{Spatial ConditionType} <Spatial ConditionTypeParams>] | Define and modify Spatial Condition components and templates. | 11.2 |
| SpatialTool Volume Grid | SpatialTool <ScenarioPath> <ParentObject> {Action} {Volume Grid | Volume GridTemplate} <Volume GridName> [{Volume GridType} <Volume GridTypeParams>] | Define and modify Volume Grid components and templates. | 11 |
| SpatialTool_R | SpatialTool_R <ScenarioPath> {Option} [<Parameters>] | Return information about Spatial components. | 11 |
| SpatialTool_RM | SpatialTool_RM <ScenarioPath> {Option} [<Parameters>] | Return information about SpatialTool components. | 11 |
| TimeTool | TimeTool <ScenarioPath> {Options} | Define components defining instances or intervals of time. | 11.5 |
| TimeTool Collection of Interval Lists | TimeTool <ScenarioPath> <ParentObject> {Action} {"Collection of Interval Lists" | "Collection of Interval ListsTemplate"} <ComponentName> [{CollectionOfIntervalListsType} <TypeParams>] | Define and modify Collection of Interval Lists components and templates. | 10.1 |
| TimeTool Interval | TimeTool <ScenarioPath> <ParentObject> {Action} {"Interval" | "IntervalTemplate"} <ComponentName> [{IntervalType} <TypeParams>] | Define and modify Interval components and templates. | 11.3 |
| TimeTool Interval List | TimeTool <ScenarioPath> <ParentObject> {Action} {"Interval List" | "Interval ListTemplate"} <ComponentName> [{IntervalListType} <TypeParams>] | Define and modify Interval List components and templates. | 11.5 |
| TimeTool Time Array | TimeTool <ScenarioPath> <ParentObject> {Action} {"Time Array" | "Time ArrayTemplate"} <ComponentName> [{TimeArrayType} <TypeParams>] | Define and modify Time Array components and templates. | 11.7.1 |
| TimeTool Time Instant | TimeTool <ScenarioPath> <ParentObject> {Action} {"Time Instant" | "Time InstantTemplate"} <ComponentName> [{TimeInstantType} <TypeParams>] | Define and modify Time Instant components and templates. | 10 |
| TimeTool_R | TimeTool_R <ScenarioPath> {Option} [<Parameters>] | Return information about TimeTool components. | 10 |
| TimeTool_RM | TimeTool_RM <ScenarioPath> {Option} [<Parameters>] | Return information about TimeTool components. | 10.1 |
| Unload | Unload <ApplicationPath> <ObjectPath> [RemAssignedObjs] | Remove an object or scenario | 4.0 |
| UnloadMulti | UnloadMulti <ApplicationPath> <ObjectPath> | Remove an object and all of its subobjects from the current scenario | 9.1 |
| VO VolumetricGfx | VO <VolumetricPath> VolumetricGfx {{GfxOptions} | {Legend Options}} | Define the 3d graphics properties of a volumetric object. | 11 |
| VO_RM VolumetricGfx | VO_RM <VolumetricPath> VolumetricGfx {Type} | Return information about Volumetric object graphics. | 11.2 |
| Volumetric | Volumetric <VolumetricPath> {Define | Compute | Clear | Reload | Export] [<Parameters>] | Define the basic properties of a Volumetric object | 11.6 |
| Volumetric_RM | Volumetric_RM <VolumetricPath> {Type} | Return information about a Volumetric object. | 11.2 |