# cee::ug::StateGroupInfo

class `StateGroupInfo`

  Simple class containing metadata info for a group of states.

  A state group info contains:

  - State group id
  - State group name
  - State ids of the states in the group

  Default state group id is -1 which indicates an invalid id.

  See also

  DataSourceDirectory and DataState

  Public Functions

  `StateGroupInfo`()

    Constructs an empty object.

    Default id is -1 (invalid)

  `StateGroupInfo`(int id, const Str &name)

    Constructs a new object with the given state group id and name.

  `StateGroupInfo`(const StateGroupInfo &other)

    Constructs a new StateGroupInfo that is a copy of other.

  StateGroupInfo &`operator=`(const StateGroupInfo &rhs)

    Assigns rhs to this state group info and returns a reference to this state group info.

  int `id`() const

    Returns the state group id.

    Returns -1 if this state group info object is invalid.

  Str `name`() const

    Returns the state group name.

  size_t `stateCount`() const

    Returns the number of states in the group.

  int `stateId`(size_t index) const

    Returns id of the state at the given index.

  void `addStateId`(int stateId)

    Adds a state to this group, defined by its id. There must not be duplicates.

  bool `hasStateId`(int stateId) const

    Returns true if the given state is in the group.

  void `clear`()

    Clears the states in the group.

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Envision for Desktop in your own language, or choose a sample question below to start a conversation:

What is HOOPS Envision for Desktop?
What are the latest release notes for HOOPS Envision for Desktop?
How do I start evaluating HOOPS Envision for Desktop?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...