Collapse All Expand All Members: Show All Members: Filtered Members: Filtered Members: Filtered

C#
Include Protected Members
Include Inherited Members

Clarion Library 6.1.1
World Members
World Class Methods Properties See Also Send Feedback

[This is preliminary documentation and is subject to change.]

The World type exposes the following members.

# Methods

| Name | Description
--- | --- | ---
| Contains(Guid) | Returns whether or not the world contains a World object with the specified world ID.
| Contains(IWorldObject) | Returns whether or not the world contains the specified World object.
| Destroy | Destroys the current singleton instance of the world class
| GetActionChunk(Guid) | Gets the action chunk with the specified world ID. If the action chunk cannot be found, this method returns null.
| GetActionChunk(IComparable) | Gets an action chunk with the specified label. If an action chunk cannot be found, this method returns null.
| GetActionChunks()()()() | Gets a thread-safe "read-only" list of all action chunks in the world.
| GetActionChunks(IComparable) | Gets a thread-safe "read-only" list of all of the action chunks in the world with the specified label.
| GetActionChunksContainingDV(Guid) | Gets a thread-safe "read-only" list of all of the action chunks in the world that contain the dimension-value pair with the specified world ID.
| GetActionChunksContainingDV(DimensionValuePair) | Gets a thread-safe "read-only" list of all of the action chunks in the world that contain the specified dimension-value pair.
| GetActionChunksContainingDV(Object, IComparable) | Gets a thread-safe "read-only" list of all of the action chunks in the world that contain the dimension-value pair with the specified dimension and value IDs.
| GetActionChunksContainingDVs(ICollection<(Of <<'(Guid>)>>)) | Gets a thread-safe "read-only" list of all of the action chunks in the world that contain all of the dimension-value pairs with the specified world IDs.
| GetActionChunksContainingDVs(ICollection<(Of <<'(DimensionValuePair>)>>)) | Gets a thread-safe "read-only" list of all of the action chunks in the world that contain all of the specified dimension-value pairs.
| GetAgent(Guid) | Gets the agent with the specified world ID. If the agent cannot be found, this method returns null.
| GetAgent(IComparable) | Gets an agent with the specified name. If an agent cannot be found, this method returns null.
| GetAgentMetaInfo(Guid) | Gets a thread-safe "read-only" list of the meta info for the agent with the specified world ID.
| GetAgentMetaInfo(Agent) | Gets a thread-safe "read-only" list of the meta info for the specified agent.
| GetAgentMetaInfo(Guid, Agent..::..InternalWorldObjectContainers) | Gets a thread-safe "read-only" list of the meta info for the specified container in the agent with the specified world ID.
| GetAgentMetaInfo(Agent, Agent..::..InternalWorldObjectContainers) | Gets a thread-safe "read-only" list of the meta info for the specified container in the specified agent.
| GetAgents()()()() | Gets a thread-safe "read-only" list of all agents in the world.
| GetAgents(IComparable) | Gets a thread-safe "read-only" list of all of the agents in the world with the specified name.
| GetDeclarativeChunk(Guid) | Gets the declarative chunk with the specified world ID. If the declarative chunk cannot be found, this method returns null.
| GetDeclarativeChunk(IComparable) | Gets a declarative chunk with the specified label. If a declarative chunk cannot be found, this method returns null.
| GetDeclarativeChunks()()()() | Gets a thread-safe "read-only" list of all declarative chunks in the world.
| GetDeclarativeChunks(IComparable) | Gets a thread-safe "read-only" list of all of the declarative chunks in the world with the specified label.
| GetDeclarativeChunksContainingDV(Guid) | Gets a thread-safe "read-only" list of all of the declarative chunks in the world that contain the dimension-value pair with the specified world ID.
| GetDeclarativeChunksContainingDV(DimensionValuePair) | Gets a thread-safe "read-only" list of all of the declarative chunks in the world that contain the specified dimension-value pair.
| GetDeclarativeChunksContainingDV(Object, IComparable) | Gets a thread-safe "read-only" list of all of the declarative chunks in the world that contain the dimension-value pair with the specified dimension and value IDs.
| GetDeclarativeChunksContainingDVs(ICollection<(Of <<'(Guid>)>>)) | Gets a thread-safe "read-only" list of all of the declarative chunks in the world that contain all of the dimension-value pairs with the specified world IDs.
| GetDeclarativeChunksContainingDVs(ICollection<(Of <<'(DimensionValuePair>)>>)) | Gets a thread-safe "read-only" list of all of the declarative chunks in the world that contain all of the specified dimension-value pairs.
| GetDimension | Gets a thread-safe "read-only" list of all the dimension-value pairs with the specified dimension ID.
| GetDimensionValuePair | Gets the dimension-value pair with the specified world ID. If the dimension-value pair cannot be found, this method returns null.
| GetDimensionValuePair<(Of <<'(dType, vType>)>>) | Gets the dimension-value pair with the specified dimension and value IDs. If the dimension-value pair cannot be found, this method returns null.
| GetDimensionValuePairs | Gets a thread-safe "read-only" list of all dimension-value pairs in the world.
| GetDimensionWorldIDs | Gets a thread-safe "read-only" list of the world IDs for all the dimension-value pairs with the specified dimension ID.
| GetGoalChunk(Guid) | Gets the goal chunk with the specified world ID. If the goal chunk cannot be found, this method returns null.
| GetGoalChunk(IComparable) | Gets a goal chunk with the specified label. If a goal chunk cannot be found, this method returns null.
| GetGoalChunks()()()() | Gets a thread-safe "read-only" list of all goal chunks in the world.
| GetGoalChunks(IComparable) | Gets a thread-safe "read-only" list of all of the goal chunks in the world with the specified label.
| GetGoalChunksContainingDV(Guid) | Gets a thread-safe "read-only" list of all of the goal chunks in the world that contain the dimension-value pair with the specified world ID.
| GetGoalChunksContainingDV(DimensionValuePair) | Gets a thread-safe "read-only" list of all of the goal chunks in the world that contain the specified dimension-value pair.
| GetGoalChunksContainingDV(Object, IComparable) | Gets a thread-safe "read-only" list of all of the goal chunks in the world that contain the dimension-value pair with the specified dimension and value IDs.
| GetGoalChunksContainingDVs(ICollection<(Of <<'(Guid>)>>)) | Gets a thread-safe "read-only" list of all of the goal chunks in the world that contain all of the dimension-value pairs with the specified world IDs.
| GetGoalChunksContainingDVs(ICollection<(Of <<'(DimensionValuePair>)>>)) | Gets a thread-safe "read-only" list of all of the goal chunks in the world that contain all of the specified dimension-value pairs.
| GetTimeStamp(Guid) | Gets the time stamp with the specified world ID. If the time stamp cannot be found, this method returns -1.
| GetTimeStamp(Int64) | Gets the time stamp with the specified long integer value. If the time stamp cannot be found, this method returns null.
| GetWorldObject | Gets the World object with the specified world ID. If the World object cannot be found, this method returns null.
| GetWorldObjects | Gets a thread-safe "read-only" list of all objects in the world.
| Initialize | Initializes a new instance of the world singleton
| NewAgent | Initializes a new agent. Also, if the optional name is specified (and is not null), then this method also generates a SemanticLabel object for the specified name (if one does not already exist for it) and adds it to the declarative chunk representation of the agent.
| NewCustomMetaCognitiveActionChunk<(Of <<'(T>)>>) | Initializes a new custom meta-cognitive action chunk (of type T). Also, if the optional label is specified (and is not null), then this method generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the action chunk (unless otherwise indicated).
| NewDeclarativeChunk | Initializes a new declarative chunk with the specified label. This method also generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the declarative chunk (unless otherwise specified).
| NewDimensionValuePair<(Of <<'(dType, vType>)>>) | Initializes a new dimension-value pair with the specified dimension and value IDs. If a dimension-value pair already exists with the specified dimension and value IDs, this method will return that dimension-value pair instead.
| NewDistributedDimensionValuePair<(Of <<'(vType>)>>) | Initializes a new distributed dimension-value pair for the specified agent using the specified value ID. If a distributed dimension-value pair already exists for the specified agent with the specified value ID, this method will return that distributed dimension-value pair instead.
| NewExternalActionChunk | Initializes a new external action chunk. Also, if the optional label is specified (and is not null), then this method generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the action chunk (unless otherwise indicated).
| NewGoalChunk | Initializes a new goal chunk. Also, if the optional label is specified (and is not null), then this method generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the action chunk (unless otherwise indicated).
| NewGoalStructureUpdateActionChunk | Initializes a new goal structure update action chunk. Also, if the optional label is specified (and is not null), then this method generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the action chunk (unless otherwise indicated).
| NewParameterChangeActionChunk | Initializes a new parameter change action chunk. Also, if the optional label is specified (and is not null), then this method generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the action chunk (unless otherwise indicated).
| NewReasoningRequestActionChunk | Initializes a new NACS reasoning action chunk. Also, if the optional label is specified (and is not null), then this method generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the action chunk (unless otherwise indicated).
| NewRetrieveRequestActionChunk | Initializes a new NACS retrieve action chunk. Also, if the optional label is specified (and is not null), then this method generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the action chunk (unless otherwise indicated).
| NewSensoryInformation(Agent, World..::..SensoryInformationIncrementOptions) | Initializes a new sensory information object for the specified agent using the specified time stamp increment option.
| NewSensoryInformation(Agent, Int64) | Initializes a new sensory information object for the specified agent at the specified time stamp.
| NewSensoryInformation(Agent, SensoryInformation, World..::..SensoryInformationIncrementOptions) | Initializes a new sensory information object for the specified agent and sets up the generated sensory information object to match the configuration of the specified sensory information object.
| NewWorkingMemoryUpdateActionChunk | Initializes a new working memory update action chunk. Also, if the optional label is specified (and is not null), then this method generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the action chunk (unless otherwise indicated).
| Remove | Removes the specified World object from the world.
| ToString | Returns a string that represents the world.

# Properties

| Name | Description
--- | --- | ---
| DimensionCount | Gets the number of dimensions for the dimension-value pairs in the world
| Instance | Gets the singleton instance of the world.
| LoggingFileName | Gets or sets the logging file name for the default trace listener
| LoggingLevel | Gets or sets the trace level to use when logging in the Clarion Library
| LoggingSwitch | Gets the logging switch used for determining whether a logging message should be written
| UseTimeStamp | Specifies whether or not time stamp dimension-value pairs should be generated.

# See Also

World Class
Clarion Namespace