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

The World type exposes the following members.

Methods

  Name Description
Public method Static member Contains(Guid)
Returns whether or not the world contains a World object with the specified world ID.
Public method Static member Contains(IWorldObject)
Returns whether or not the world contains the specified World object.
Public method Static member Destroy
Destroys the current singleton instance of the world class
Public method Static member GetActionChunk(Guid)
Gets the action chunk with the specified world ID. If the action chunk cannot be found, this method returns null.
Public method Static member GetActionChunk(IComparable)
Gets an action chunk with the specified label. If an action chunk cannot be found, this method returns null.
Public method Static member GetActionChunks()()()()
Gets a thread-safe "read-only" list of all action chunks in the world.
Public method Static member GetActionChunks(IComparable)
Gets a thread-safe "read-only" list of all of the action chunks in the world with the specified label.
Public method Static member 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.
Public method Static member 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.
Public method Static member 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.
Public method Static member 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.
Public method Static member 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.
Public method Static member GetAgent(Guid)
Gets the agent with the specified world ID. If the agent cannot be found, this method returns null.
Public method Static member GetAgent(IComparable)
Gets an agent with the specified name. If an agent cannot be found, this method returns null.
Public method Static member GetAgentMetaInfo(Guid)
Gets a thread-safe "read-only" list of the meta info for the agent with the specified world ID.
Public method Static member GetAgentMetaInfo(Agent)
Gets a thread-safe "read-only" list of the meta info for the specified agent.
Public method Static member 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.
Public method Static member GetAgentMetaInfo(Agent, Agent..::..InternalWorldObjectContainers)
Gets a thread-safe "read-only" list of the meta info for the specified container in the specified agent.
Public method Static member GetAgents()()()()
Gets a thread-safe "read-only" list of all agents in the world.
Public method Static member GetAgents(IComparable)
Gets a thread-safe "read-only" list of all of the agents in the world with the specified name.
Public method Static member GetDeclarativeChunk(Guid)
Gets the declarative chunk with the specified world ID. If the declarative chunk cannot be found, this method returns null.
Public method Static member GetDeclarativeChunk(IComparable)
Gets a declarative chunk with the specified label. If a declarative chunk cannot be found, this method returns null.
Public method Static member GetDeclarativeChunks()()()()
Gets a thread-safe "read-only" list of all declarative chunks in the world.
Public method Static member GetDeclarativeChunks(IComparable)
Gets a thread-safe "read-only" list of all of the declarative chunks in the world with the specified label.
Public method Static member 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.
Public method Static member 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.
Public method Static member 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.
Public method Static member 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.
Public method Static member 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.
Public method Static member GetDimension
Gets a thread-safe "read-only" list of all the dimension-value pairs with the specified dimension ID.
Public method Static member GetDimensionValuePair
Gets the dimension-value pair with the specified world ID. If the dimension-value pair cannot be found, this method returns null.
Public method Static member 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.
Public method Static member GetDimensionValuePairs
Gets a thread-safe "read-only" list of all dimension-value pairs in the world.
Public method Static member GetDimensionWorldIDs
Gets a thread-safe "read-only" list of the world IDs for all the dimension-value pairs with the specified dimension ID.
Public method Static member GetGoalChunk(Guid)
Gets the goal chunk with the specified world ID. If the goal chunk cannot be found, this method returns null.
Public method Static member GetGoalChunk(IComparable)
Gets a goal chunk with the specified label. If a goal chunk cannot be found, this method returns null.
Public method Static member GetGoalChunks()()()()
Gets a thread-safe "read-only" list of all goal chunks in the world.
Public method Static member GetGoalChunks(IComparable)
Gets a thread-safe "read-only" list of all of the goal chunks in the world with the specified label.
Public method Static member 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.
Public method Static member 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.
Public method Static member 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.
Public method Static member 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.
Public method Static member 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.
Public method Static member GetTimeStamp(Guid)
Gets the time stamp with the specified world ID. If the time stamp cannot be found, this method returns -1.
Public method Static member GetTimeStamp(Int64)
Gets the time stamp with the specified long integer value. If the time stamp cannot be found, this method returns null.
Public method Static member GetWorldObject
Gets the World object with the specified world ID. If the World object cannot be found, this method returns null.
Public method Static member GetWorldObjects
Gets a thread-safe "read-only" list of all objects in the world.
Public method Static member Initialize
Initializes a new instance of the world singleton
Public method Static member 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.
Public method Static member 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).
Public method Static member 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.
Public method Static member 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.
Public method Static member NewExternalActionChunk
Initializes a new external action chunk. Also, if the optional label is specified (and is not null), then this method also generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the action chunk.
Public method Static member NewGoalChunk
Initializes a new goal chunk. Also, if the optional label is specified (and is not null), then this method also generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the goal chunk.
Public method Static member NewGoalStructureUpdateActionChunk
Initializes a new goal structure update action chunk. Also, if the optional label is specified (and is not null), then this method also generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the action chunk.
Public method Static member NewNACSReasoningActionChunk
Initializes a new NACS reasoning action chunk. Also, if the optional label is specified (and is not null), then this method also generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the action chunk.
Public method Static member NewNACSRetrieveActionChunk
Initializes a new NACS retrieve action chunk. Also, if the optional label is specified (and is not null), then this method also generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the action chunk.
Public method Static member NewParameterChangeActionChunk
Initializes a new parameter change action chunk. Also, if the optional label is specified (and is not null), then this method also generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the action chunk.
Public method Static member NewSensoryInformation(Agent, SensoryInformation)
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.
Public method Static member NewSensoryInformation(Agent, World..::..SensoryInformationIncrementOptions)
Initializes a new sensory information object for the specified agent using the specified time stamp increment option.
Public method Static member NewSensoryInformation(Agent, Int64)
Initializes a new sensory information object for the specified agent at the specified time stamp.
Public method Static member NewWorkingMemoryUpdateActionChunk
Initializes a new working memory update action chunk. Also, if the optional label is specified (and is not null), then this method also generates a SemanticLabel object for the specified label (if one does not already exist for it) and adds it to the action chunk.
Public method Static member Remove
Removes the specified World object from the world.
Public method Static member ToString
Returns a string that represents the world.

Properties

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

See Also